duskos

commit ee61b77c523ba0c4ace3c69c541c77034f9ea565
parent fc3e008ae53dec2bddecab5ffbd80d104fb2a591
Author: Virgil Dupras <hsoft@hardcoded.net>
Date:   Tue, 13 Dec 2022 19:39:25 -0500

doc: add master index

Diffstat:
M
README.md
 | 
7
+++----
A
fs/doc/index.txt
 | 
31
+++++++++++++++++++++++++++++++

2 files changed, 34 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -187,8 +187,8 @@ so that's why it exists. To build this VM, you need:
 Running `make` will yield a `./dusk` binary which if opened, provides an
 interactive prompt.
 
-Documentation lives in `fs/doc`. You can begin with [doc/usage][usage] and
-refer to [doc/dict][dict] for a vocabulary reference. Type `bye` to quit.
+Documentation lives in `fs/doc`. You can begin with [doc/index][docs]. Type
+`bye` to quit.
 
 Dusk OS expects a raw input. With a regular TTY, your input will be buffered
 and echoed twice. To avoid that, you can invoke it like this:
@@ -218,8 +218,7 @@ BIOS" mode.
 [simplicity]: fs/doc/design/simple.txt
 [limits]: fs/doc/design/limits.txt
 [port]: fs/doc/design/port.txt
-[usage]: fs/doc/usage.txt
-[dict]: fs/doc/dict.txt
+[docs]: fs/doc/index.txt
 [roadmap]: ROADMAP.md
 [shproj]: https://sr.ht/~vdupras/duskos
 [mailinglist]: https://sr.ht/~vdupras/duskos/lists
diff --git a/fs/doc/index.txt b/fs/doc/index.txt
@@ -0,0 +1,31 @@
+# Dusk OS documentation
+
+Welcome to Dusk OS documentation, which is still a work in progress, but covers
+enough to get someone started.
+
+## Where to start
+
+If you read this from a POSIX machine, the easiest way to get started is to
+follow instructions of the README file at the root of the Dusk package. Then,
+begin with doc/usage.
+
+If you're reading this from a Dusk system, then you're ready to read doc/usage.
+
+## Contents of this documentation
+
+usage     General usage guide
+dict      Dictionary of system word
+install   Deploy Dusk to another machine
+terms     Terminology
+dirs      Directory structure
+arch      Architecture details
+impl      Implementation details
+code      Code conventions
+io        I/O API
+drive     Drive API
+file      File API
+alloc     Memory allocation API
+x86       i386 implementation details
+asm/      Assemblers documentation
+cc/       C compiler documentation
+design/   Description and justification of design decisions