mirror of
https://github.com/apache/nuttx.git
synced 2026-06-02 09:38:37 +08:00
convert TODOs to actual TODO banner and improve general presentation of different sections
This commit is contained in:
@@ -1,12 +1,13 @@
|
||||
.. todo::
|
||||
This should be a brief introduction to how NuttX works and how to get it running. A widely used board could be targeted to create a brief demonstration on how to clone, configure, build, flash and run NuttX.
|
||||
For now, the content that is here presented is what remains of the old Porting Guide which is not already in another section of this documentation.
|
||||
|
||||
==========
|
||||
Quickstart
|
||||
==========
|
||||
|
||||
.. note::
|
||||
This should be a brief introduction to how NuttX works and how to get it running. A widely used board could be targeted to create a brief demonstration on how to clone, configure, build, flash and run NuttX.
|
||||
For now, I've included the parts of the old porting guide which seemed more relevant for this section, but should be revised and made
|
||||
(new) user friendly.
|
||||
|
||||
The present Quickstart guide is a work in progress and only contains some basic information. In the meantime you can look at NuttX main `README <https://github.com/apache/incubator-nuttx/blob/master/README.md>`_ file which contains some information that will help you get started.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
|
||||
Reference in New Issue
Block a user