https://github.com/jeanguyomarch/nanok

A nano-kernel for microcontrollers
https://github.com/jeanguyomarch/nanok

kernel microcontrollers

Last synced: 21 days ago
JSON representation

A nano-kernel for microcontrollers

• Host: GitHub
• URL: https://github.com/jeanguyomarch/nanok
• Owner: jeanguyomarch
• License: mit
• Created: 2018-09-30T09:29:45.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-23T20:01:39.000Z (over 6 years ago)
• Last Synced: 2024-11-16T06:07:53.128Z (3 months ago)
• Topics: kernel, microcontrollers
• Language: C
• Homepage: https://nanok.readthedocs.io/
• Size: 1.21 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
===============================================================================

 NanoK

===============================================================================

|build-status| |docs|

-------------------------------------------------------------------------------

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 ``_.

To build the documentation, you will need `sphinx`_ to be installed:

.. code:: sh

   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:

.. code:: sh

   make -C docs html

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

   

.. |build-status| image:: https://img.shields.io/travis/jeanguyomarch/nanok.svg?style=flat

    :alt: build status

    :scale: 100%

    :target: https://travis-ci.org/jeanguyomarch/nanok

.. |docs| image:: https://readthedocs.org/projects/nanok/badge/?version=latest

    :alt: Documentation Status

    :scale: 100%

    :target: https://nanok.readthedocs.org

.. _sphinx: http://www.sphinx-doc.org