Shunchao Hu
18cd40cd5d
Update the NAT documentation to make the validation flow easier to follow. The existing document already contains useful details, but the test setup is hard to read for beginners. - In particular, the NuttX-side commands and Linux host commands can be confused - Some commands are redundant - Some required steps are missing - The Internet access example is not necessary for NAT behavior itself Simplify the validation case to use a local topology with Linux network namespaces. Add an ICMP test case and the required explanations around the NuttX iptables command and interface roles. Remove the IPv6 validation case from this doc, since the NAT66 flow follows the same structure as the NAT44 case. Signed-off-by: Shunchao Hu <ankohuu@gmail.com>
Apache 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()).
For brevity, many parts of the documentation will refer to Apache NuttX as simply NuttX.
Getting Started
First time on NuttX? Read the Getting Started guide! If you don't have a board available, NuttX has its own simulator that you can run on terminal.
Documentation
You can find the current NuttX documentation on the Documentation Page.
Alternatively, you can build the documentation yourself by following the Documentation Build Instructions.
The old NuttX documentation is still available in the Apache wiki.
Supported Boards
NuttX supports a wide variety of platforms. See the full list on the Supported Platforms page.
Contributing
If you wish to contribute to the NuttX project, read the Contributing guidelines for information on Git usage, coding standard, workflow and the NuttX principles.
License
The code in this repository is under either the Apache 2 license, or a license compatible with the Apache 2 license. See the License Page for more information.