incubator-nuttx/Documentation/index.rst

36 lines
1.4 KiB
ReStructuredText
Raw Normal View History

.. note::
The present documentation is a recent addition to NuttX and was migrated from previous
documentation content. For this reason, it is possible you may find broken links or
formatting errors. You can help contribute fixes or improvements to this documentation
by following these :doc:`instructions <contributing/documentation>`.
.. tip::
You can find the old documentation `here <https://cwiki.apache.org/confluence/display/NUTTX/Documentation>`_.
2020-07-21 06:18:26 +08:00
===================
NuttX Documentation
===================
NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOSs (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).
2020-07-21 06:18:26 +08:00
Last Updated: |today|
.. toctree::
:caption: Table of Contents
2020-07-21 06:18:26 +08:00
:maxdepth: 2
Home <self>
introduction/index.rst
2020-07-21 06:18:26 +08:00
quickstart/index.rst
contributing/index.rst
introduction/inviolables.rst
platforms/index.rst
2020-07-21 06:18:26 +08:00
components/index.rst
applications/index.rst
reference/index.rst
2021-04-15 00:46:51 +08:00
faq/index.rst
guides/index.rst
2020-08-15 02:26:05 +08:00
glossary.rst
2020-07-21 06:18:26 +08:00
.. include:: substitutions.rst