# Dusk OS documentation

## 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.

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
dirs      Directory structure
deploy    Deploy Dusk to another machine
arch      Architecture details
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 and driver documentation
