nuttx/Documentation/quickstart/index.rst
Adam Feuer b88038a1e1 add quickstart docs from NuttX Companion
- with suggested edits from PR feedback
2020-09-04 20:03:49 -03:00

29 lines
943 B
ReStructuredText

.. todo::
===============
Getting Started
===============
This section describes how to get started with NuttX. :ref:`quickstart/quickstart:Quickstart` is for
experienced embedded developers, and quickly outlines the basic of getting NuttX configured and
compiled. Use this if you are experienced with FreeRTOS, Zephyr, or a similar RTOS.
The remaining sections are detailed instructions aimed at beginners for getting the necessary
compilers and other tools installed, then compiling NuttX and running on your hardware. There are sections
on configuring NuttX with more features than just the minimum, and a section on debugging. For reference
there is also a description of the code organization and some details about what happens when running ``make``
to build NuttX.
.. toctree::
:maxdepth: 1
quickstart.rst
install.rst
compiling.rst
running.rst
configuring.rst
debugging.rst
organization.rst
build_and_make.rst