aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2024-08-19 15:08:29 -0400
committerBruce Hill <bruce@bruce-hill.com>2024-08-19 15:08:29 -0400
commit3aad698b2b198e3308a8d21c07465b2db6bbde2f (patch)
tree5547e9c374d548539f5095cd34afa2ae50cedc96 /README.md
parent352b5adfa556eab9fc8a8eda2ec85c3a8b242a98 (diff)
Update docs with links
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 19 insertions, 18 deletions
diff --git a/README.md b/README.md
index e595aa8f..2d72924b 100644
--- a/README.md
+++ b/README.md
@@ -32,21 +32,25 @@ language features.
### Performance
- Extremely high performance code generation with minimal overhead compared to C
-- Extremely fast parallel compilation times
+- Extremely fast parallel [compilation](docs/compilation.md) times
- Language-level support for correct function caching
-- Structs with known-at-compile-time methods, not OOP objects with vtable
- lookups
+- [Structs](docs/structs.md) with known-at-compile-time methods, not OOP
+ objects with vtable lookups
## Safety
-- Memory safety (garbage collection, compiler-enforced null safety, automatic
- array bounds checking, and no uninitialized variables)
-- Arbitrary-precision integers by default with opt-in fixed-with integers with
- arithmetic overflow checking
-- Type-safe strings representing different languages with automatic prevention
- of code injection
-- Pattern matching with exhaustiveness checking for tagged unions
-- Efficient immutable datastructures
-- Privacy-protecting types that help prevent logging sensitive information
+- Memory safety (garbage collection, [compiler-enforced null
+ safety](docs/pointers.md), [automatic array bounds
+ checking](docs/arrays.md), and no uninitialized variables)
+- [Arbitrary-precision integers](docs/integers.md) by default with opt-in
+ fixed-with integers with arithmetic overflow checking
+- [Type-safe strings representing different languages](docs/langs.md) with
+ automatic prevention of code injection
+- Pattern matching with exhaustiveness checking for [tagged unions
+ (enums)](docs/enums.md)
+- Efficient immutable datastructures: [arrays](docs/arrays.md),
+ [tables](docs/tables.md), [sets](docs/sets.md), [text](docs/text.md).
+- [Privacy-protecting types](docs/structs.md#Secret-Values) that help prevent
+ logging sensitive information
## Simplicity
- Simple, low-boilerplate type system with type inference
@@ -54,13 +58,10 @@ language features.
- No polymorphism, generics, or inheritance
## User-friendliness
-- Useful and efficient built-in types: arrays, hash tables, sets, structs,
- tagged unions (sum types), cords (efficient string representation)
-- String interpolation and debug printing builtins
+- [String interpolation](docs/text.md) and debug printing builtins
- Docstring tests with syntax highlighted output
- user-friendliness
-- Full-featured modules
-- Full UTF8 support for all text operations
+- Full-featured [libraries/modules](docs/libraries.md)
+- [Full UTF8 support](docs/text.md) for all text operations
- Built-in doctests with syntax highlighting
- Automatic command line argument parsing with type safety
- Easy interoperability with C