The Xous Operating System Book

This repository contains the source of "The Xous Operating System" book.

The book is available online at https://betrusted.io/xous-book/

Requirements

Building the book requires mdBook, ideally the same version that rust-lang/rust uses in this file. To get it:

Run these steps from your home directory, not the project directory.

$ cargo install mdbook --vers [version-num]
$ cargo install mdbook-pdf # to generate pdf

Building

Run this step from the project directory. To build the book, type:

$ mdbook build

The output will be in the book subdirectory. To check it out, open it in your web browser.

You'll also find a book/pdf/output.pdf PDF file.

Firefox:

$ firefox book/index.html                       # Linux
$ open -a "Firefox" book/index.html             # OS X
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
$ start firefox.exe .\book\index.html           # Windows (Cmd)

Chrome:

$ google-chrome book/index.html                 # Linux
$ open -a "Google Chrome" book/index.html       # OS X
$ Start-Process "chrome.exe" .\book\index.html  # Windows (PowerShell)
$ start chrome.exe .\book\index.html            # Windows (Cmd)

To run the tests:

$ mdbook test

Contributing

We'd love your help! Please see CONTRIBUTING.md to learn about the kinds of contributions we're looking for.

Translations

We'd love help translating the book! See the Translations label to join in efforts that are currently in progress. Open a new issue to start working on a new language! We're waiting on mdbook support for multiple languages before we merge any in, but feel free to start!

Spellchecking

To scan source files for spelling errors, you can use the spellcheck.sh script available in the ci directory. It needs a dictionary of valid words, which is provided in ci/dictionary.txt. If the script produces a false positive (say, you used word BTreeMap which the script considers invalid), you need to add this word to ci/dictionary.txt (keep the sorted order for consistency).