This is the NuttX Companion, a warm and friendly guide to all things NuttX– how to install it, configure it, develop on it, debug it, improve it, get help from its community, and generally have fun with this very capable, configurable, fast, POSIX-compatible, internet-connected real-time operating system.
Hopefully this guide will complement the NuttX documentation, filling in gaps when needed, and providing more help for people interested in learning about NuttX.
You can see the HTML version of this book here: NuttX Companion.
This book is written in ReStructured Text (RST), and built using the excellent Sphinx documentation system.
To install it, first install Python 3.8 or later and Pipenv. Then do:
$ cd nuttx-companion
$ pipenv install
$ pipenv shell
$ cd docs
$ make html
The documentation will be in the _build/html directory. You can open _build/html/index.html.
If there's anything you would like to improve, send me an email or a pull request! See Contributing to the NuttX Companion for more information.
cheers
adam
--
Adam Feuer
Seattle, WA, USA