summaryrefslogtreecommitdiff
path: root/doc/index.md
diff options
context:
space:
mode:
authorTaylan Kammer <taylan.kammer@gmail.com>2026-06-01 21:49:37 +0200
committerTaylan Kammer <taylan.kammer@gmail.com>2026-06-01 21:49:37 +0200
commit724ac8ae394675a78c2977c6e35555b210256e01 (patch)
treed7f5574b49ec71341ea8079f18a33b9c17b60221 /doc/index.md
parent9ce0aa66cedc985322e06db4bac130910610c113 (diff)
docs -> doc
Diffstat (limited to 'doc/index.md')
-rw-r--r--doc/index.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/index.md b/doc/index.md
new file mode 100644
index 0000000..beaa78c
--- /dev/null
+++ b/doc/index.md
@@ -0,0 +1,32 @@
+# 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/)
+
+ 1. [Parse](c1/1-parse.html)
+ 2. [Decode](c1/2-decode.html)
+ 3. [Execute](c1/3-execute.html)
+ 4. [Compile](c1/4-compile.html)
+
+2. [Chapter 2: Types](c2/)
+
+ This chapter deals with the standard data types, and the methods
+ Zisp offers for defining new types.
+
+ 1. ...
+ 2. ...
+
+3. [Chapter 3: ...](c3/)