aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJJ2023-07-10 05:56:44 +0000
committerJJ2023-07-10 06:39:32 +0000
commitfbe825e6d74a08b1a4ffada6c9a0934d7fb0d19f (patch)
treed741eeba0c0676bc6ee06458dcd6baa59e44e9a2 /README.md
parent86f59f9ebb36c322bedd89dde1e4bf813f0f6372 (diff)
basic usage w/o examples
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/README.md b/README.md
index ee6d4a3..3fb1cb2 100644
--- a/README.md
+++ b/README.md
@@ -45,21 +45,22 @@ Why not Koka?
## How do I learn more?
- The [basic usage](BASIC.md) document lays out the fundamental grammar of Puck.
-- The [syntax](SYNTAX.md) document provides a deeper look into the syntax choices.
+- The [syntax](BASIC.md) document provides a deeper look into the syntax choices made.
- The [grammar](GRAMMAR.md) document provides a formal grammar for Puck, which the parser is based upon.
-- The [type system](TYPES.md) document gives an in-depth analysis of Puck's extensive type system, and its relationship to classes and other abstractions.
-- The [memory management](MEMORY_MANAGEMENT.md) document gives an overview of Puck's memory model: which is considered a mashup of the models pioneered by Lobster, Rust, and Nim.
-- The [effect system](EFFECTS.md) document gives a description of Puck's effects system: and how it ties into asynchronous code and exceptions.
+- The [type system](TYPES.md) document gives an in-depth analysis of Puck's extensive type system. <!-- and its relationship to classes and other abstractions. -->
+- The [memory management](MEMORY_MANAGEMENT.md) document gives an overview of Puck's memory model. <!-- which is considered a mashup of the models pioneered by Lobster, Rust, and Nim. -->
+- The [metaprogramming](METAPROGRAMMING.md) document explains how using metaprogramming to extend the language works. <!-- and write more powerful code works. -->
+- The [asynchronous](ASYNC.md) document gives an overview of the intertwining of Puck's asynchronous support with other language features.
+- The [effect system](EFFECTS.md) document gives a description of how Puck's effect handler system works.
- The [interop](INTEROP.md) document gives an overview of how the first-class language interop system works.
-- The [metaprogramming](METAPROGRAMMING.md) document explains how using metaprogramming to extend the language and write more powerful code works.
-- The [syntax](SYNTAX.md) document provides a more detailed look at the syntax of the language.
- The [modules](MODULES.md) document provides a more detailed look at imports and how they relate to the type system.
- The [roadmap](ROADMAP.md) provides a clear view of the current state and future plans of the language's development.
- The [standard library](STDLIB.md) document provides an overview and examples of usage of the standard library.
-- The [extended library](EXTLIB.md) document provides an overview and examples of usage of the _extended_ standard library.
-<!-- - The [asynchronous](ASYNC.md) document gives an overview of the intertwining of Puck's asynchronous support with other language features. -->
+- The [extended library](EXTLIB.md) document provides an overview and examples of usage of the _extended_ library.
-Note that all of these documents (and parts of this README) are written as if everything already exists. Nothing already exists! You can see the [roadmap](ROADMAP.md) for an actual sense as to the state of the language. I just found writing in the present tense to be an easier way to collect my thoughts.
+These are best read in order.
+
+Note that all of these documents (and parts of this README) are written as if everything already exists. Nothing already exists! You can see the [roadmap](ROADMAP.md) for an actual sense as to the state of the language. I simply found writing in the present tense to be an easier way to collect my thoughts.
## Acknowledgements