# Dusk OS documentation

## In-system help

If you see this after having typed "help", what you see is the result of the
unit [text/help] having invoked [text/ged] to open doc/index.txt. You are now
in the "ged" text editor. You can quit it with 'q'.

You can scroll up and down with '[' and ']' and move the cursor with 'h/j/k/l'.
You can follow links (for example, [lib/str] is a link) by placing the cursor
over that link and press CTRL+E.

This opens a new editor buffer. You can cycle through opened buffers with
CTRL+].

## Where to start

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/operator, then
doc/usage/index.

## Contents of this documentation

Documentation about specific units have the same path in the documentation as
they have in the system and are not listed below. For example, for documentation
about io/stream, you'll want to open doc/io/stream.txt .

The list below is in rough suggested reading order.

operator  Hello Operator!
usage     General usage guide
dict      Dictionary of system word
hal       Harmonized Assembly Layer
terms     Terminology
data      Fundamental data structures
dirs      Directory structure
deploy    Deploy Dusk to another machine
kernel    Anatomy of a kernel
boot      Boot Sequence
code      Understanding Dusk's code
tips      Tips and tricks
design    Description and justification of design decisions
hw        Hardware notes
