aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJJ2024-01-02 06:01:42 +0000
committerJJ2024-01-02 06:01:42 +0000
commit4852f1caabcbcd5ad3dd5696bfe4bc428d653f94 (patch)
tree10bf2f7c1c4d0b5691d8e1be66022f5d41b90400
parentd91543bc481401f0b3db3abcec43dbf3acf167e6 (diff)
docs: rename overview
-rw-r--r--README.md2
-rw-r--r--docs/OVERVIEW.md (renamed from docs/BASIC.md)0
-rw-r--r--docs/SUMMARY.md44
3 files changed, 45 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5a5d5e9..3fc6286 100644
--- a/README.md
+++ b/README.md
@@ -113,7 +113,7 @@ 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](docs/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.
-This language does not currently integrate ideas from the following areas of active research: effects systems, refinement types (including ranges), and dependent types.
+This language does not currently integrate ideas from the following areas of active research: effects systems, refinement types, and dependent types. It plans to integrate refinement types in the future as a basis for `range[]` types, and to explore safety and optimizations surrounding integer overflow.
## Primary References
- [The Rust I wanted had no future](https://graydon2.dreamwidth.org/307291.html)
diff --git a/docs/BASIC.md b/docs/OVERVIEW.md
index df4b22f..df4b22f 100644
--- a/docs/BASIC.md
+++ b/docs/OVERVIEW.md
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
new file mode 100644
index 0000000..35374e8
--- /dev/null
+++ b/docs/SUMMARY.md
@@ -0,0 +1,44 @@
+# Summary
+
+[The Puck Programming Language](../README.md)
+
+- [Basic Usage](OVERVIEW.md)
+ - [Variables and Comments]()
+ - [Basic Types]()
+ - [Functions and Calls]()
+ - [Boolean and Integer Operations]()
+ - [Conditionals and Control Flow]()
+ - [Error Handling]()
+ - [Loops and Iterators]()
+ - [Modules]()
+ - [Compile-time Programming]()
+ - [Async and Threading]()
+ - [Advanced Types]()
+- [Syntax](SYNTAX.md)
+ - [Indentation Rules]()
+ - [Reserved Keywords]()
+ - [A Formal Grammar]()
+- [Type System](TYPES.md)
+ - [Basic Types]()
+ - [Parameter Types]()
+ - [Reference Types]()
+ - [Abstract Types]()
+ - [Advanced Types]()
+- [Module System [todo]](MODULES.md)
+ - [Implicit Modules]()
+ - [Namespacing]()
+ - [Interfaces, Again]()
+- [Error Handling](ERRORS.md)
+- [Async System](ASYNC.md)
+ - [Threading]()
+- [Metaprogramming](METAPROGRAMMING.md)
+- [Memory Management [todo]](MEMORY_MANAGEMENT.md)
+ - [Reference Counting Optimizations]()
+ - [Annotations and Ownership]()
+- [Language Interop [draft]](INTEROP.md)
+ - [Rust, Swift, Nim]()
+ - [Java, Kotlin]()
+ - [Python, Racket, C]()
+- [Refinement Types [draft]](REFINEMENTS.md)
+- [Dependent Types [draft]](DEPENDENT_TYPES.md)
+- [Effects System [draft]](EFFECTS.md)