/nanok

A nano-kernel for microcontrollers

Primary LanguageCMIT LicenseMIT

NanoK

build status Documentation Status

What is this?

NanoK is a kernel for microcontrollers that is so small it is a nano-kernel (hence its name "NanoK"). It shall be compiled with the application, in a unikernel fashion.

Documentation

The documentation of NanoK is available at https://nanok.readthedocs.io. To build the documentation, you will need sphinx to be installed:

pip install --user sphinx sphinx-autobuild sphinx_rtd_theme breathe

Then, use docs/Makefile to produce the documentation in your favorite format. For instance, to generate and open the HTML documentation:

make -C docs html
xdg-open docs/build/html/index.html