Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/betrusted-io/xous-book
Documentation on the Xous operating system
https://github.com/betrusted-io/xous-book
Last synced: 2 days ago
JSON representation
Documentation on the Xous operating system
- Host: GitHub
- URL: https://github.com/betrusted-io/xous-book
- Owner: betrusted-io
- License: apache-2.0
- Created: 2021-08-11T07:10:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-28T18:59:18.000Z (7 months ago)
- Last Synced: 2024-06-28T20:09:24.970Z (7 months ago)
- Language: Rust
- Size: 9.14 MB
- Stars: 26
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# 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][rust-mdbook]. To get it:
[mdBook]: https://github.com/rust-lang-nursery/mdBook
[rust-mdbook]: https://github.com/rust-lang/rust/blob/master/src/tools/rustbook/Cargo.toml
```bash
$ cargo install mdbook --vers [version-num]
```
## Building
To build the book, type:
```bash
$ mdbook build
```
The output will be in the `book` subdirectory. To check it out, open it in
your web browser.
_Firefox:_
```bash
$ 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:_
```bash
$ 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:
```bash
$ mdbook test
```
## Contributing
We'd love your help! Please see [CONTRIBUTING.md][contrib] to learn about the
kinds of contributions we're looking for.
[contrib]: https://github.com/betrusted-io/xous-book/blob/main/CONTRIBUTING.md
### 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!
[Translations]: https://github.com/betrusted-io/xous-book/issues?q=is%3Aopen+is%3Aissue+label%3ATranslations
[mdbook support]: https://github.com/rust-lang-nursery/mdBook/issues/5
## 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).