# 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

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.

## 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 sys/io, you'll want to open doc/sys/io.

operator  Hello Operator!
usage     General usage guide
dict      Dictionary of system word
hal       Harmonized Assembly Layer
deploy    Deploy Dusk to another machine
terms     Terminology
dirs      Directory structure
arch      Architecture details
kernel    Anatomy of a kernel
boot      Boot Sequence
code      Understanding Dusk's code
tips      Tips and tricks
asm/      Assemblers documentation
cc/       C compiler documentation
design/   Description and justification of design decisions
hw/       Hardware and driver documentation

## Prerequisites

Documentation often refer to concepts explained elsewhere. When that's the case,
the page will begin with a "Prerequisites:" line with references to other doc
pages. It is assumed that the reader for a given page has also read
prerequisites. "usage" and "dict" are prerequisites to all other pages and are
not explicitly listed.
