summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTaylan Kammer <taylan.kammer@gmail.com>2026-01-08 14:54:20 +0100
committerTaylan Kammer <taylan.kammer@gmail.com>2026-01-08 14:54:20 +0100
commit8012e3fe177069a709f30d2ab4a18ff11025c86f (patch)
treea6e75e6a3a56ff3fc6f056f6347e58329915725b
parentcf2697d24c13cdc7ea5f93ce0ff5143f41a85a83 (diff)
Draft a Manual front-page.
-rw-r--r--docs/c1/1-parse.md (renamed from docs/parser.md)0
-rw-r--r--docs/c1/2-decode.md (renamed from docs/decoder.md)0
-rw-r--r--docs/index.md36
3 files changed, 36 insertions, 0 deletions
diff --git a/docs/parser.md b/docs/c1/1-parse.md
index a23ebbc..a23ebbc 100644
--- a/docs/parser.md
+++ b/docs/c1/1-parse.md
diff --git a/docs/decoder.md b/docs/c1/2-decode.md
index 0b34204..0b34204 100644
--- a/docs/decoder.md
+++ b/docs/c1/2-decode.md
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..ca8d814
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,36 @@
+# Zisp Manual
+
+This document explains the Zisp language and its implementation.
+
+Zisp intentionally blurs the line between developers and users of the
+language. After all, Zisp is software, and its users are software
+developers; the easiest way to explain *why* Zisp does certain things
+is often to explain *how* it does them.
+
+That doesn't mean this manual will walk you through the source code
+line by line. Instead, consider it a documentation of the code base
+at large, doubling as a reference to the language implemented by the
+code base.
+
+## Table of Contents
+
+1. [Chapter 1: Genesis](c1/)
+
+ This chapter goes through the processes involved in reading source
+ files and ultimately producing binaries from them.
+
+ 1. [Parse](c1/1-parse.html)
+ 2. [Decode](c1/2-decode.html)
+ 3. [Expand](c1/3-expand.html)
+ 4. [Execute](c1/4-execute.html)
+ 5. [Compile](c1/5-compile.html)
+
+2. [Chapter 2: Types](c2/)
+
+ Following is an enumeration of the standard data types, and the
+ methods Zisp offers for generating new types.
+
+ 1. ...
+ 2. ...
+
+3. [Chapter 3: ...]