2023-10-12 23:12:35 +08:00
< p align = "center" >
< img src = "https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width = "175" >
< / p >
[](https://nuttx.apache.org/docs/latest/introduction/licensing.html)
[](https://github.com/apache/nuttx/graphs/contributors)
[](https://github.com/apache/nuttx/actions/workflows/build.yml)
[](https://nuttx.apache.org/docs/latest/index.html)
2020-07-29 00:47:30 +08:00
2022-11-17 21:03:26 +08:00
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
2023-10-12 23:12:35 +08:00
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()).
2009-10-15 05:54:31 +08:00
2023-10-12 23:12:35 +08:00
For brevity, many parts of the documentation will refer to Apache NuttX as simply NuttX.
2011-08-27 22:58:42 +08:00
2023-10-12 23:12:35 +08:00
## Getting Started
First time on NuttX? Read the [Getting Started ](https://nuttx.apache.org/docs/latest/quickstart/index.html ) guide!
If you don't have a board available, NuttX has its own simulator that you can run on terminal.
2015-06-30 08:19:36 +08:00
2023-10-12 23:12:35 +08:00
## Documentation
You can find the current NuttX documentation on the [Documentation Page ](https://nuttx.apache.org/docs/latest/ ).
2012-11-09 22:54:29 +08:00
2023-10-12 23:12:35 +08:00
Alternatively, you can build the documentation yourself by following the Documentation Build [Instructions ](https://nuttx.apache.org/docs/latest/contributing/documentation.html ).
2015-06-30 08:19:36 +08:00
2023-10-12 23:12:35 +08:00
The old NuttX documentation is still available in the [Apache wiki ](https://cwiki.apache.org/NUTTX/NuttX ).
2015-06-30 08:19:36 +08:00
2023-10-12 23:12:35 +08:00
## Supported Boards
NuttX supports a wide variety of platforms. See the full list on the [Supported Platforms ](https://nuttx.apache.org/docs/latest/platforms/index.html ) page.
2015-06-30 08:19:36 +08:00
2023-10-12 23:12:35 +08:00
## Contributing
If you wish to contribute to the NuttX project, read the [Contributing ](https://nuttx.apache.org/docs/latest/contributing/index.html ) guidelines for information on Git usage, coding standard, workflow and the NuttX principles.
2015-06-30 08:19:36 +08:00
2023-10-12 23:12:35 +08:00
## 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 ](https://nuttx.apache.org/docs/latest/introduction/licensing.html ) for more information.
