mirror of
https://github.com/apache/nuttx.git
synced 2026-05-20 12:22:03 +08:00
muyangren
eea9d15b41
Build Documentation / build-html (push) Has been cancelled
Fix multiple documentation issues in README.md and CONTRIBUTING.md: * README.md: Merge multi-line badge markdown into single lines for License and Contributors badges to follow standard markdown format. * CONTRIBUTING.md: Remove extra space in Inviolable Principles link URL. * CONTRIBUTING.md: Fix duplicate numbering in section 1.17 Merge rules (two items numbered 3, renumbered to 3, 4, 5). * CONTRIBUTING.md: Fix typo in section 2.2 commit template example, "different thing" to "different things" (missing plural). Signed-off-by: aiduxiaoxiong <aiduxiaoxiong@users.noreply.github.com>
41 lines
2.7 KiB
Markdown
41 lines
2.7 KiB
Markdown
<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)
|
|
|
|
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](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.
|
|
|
|
## Documentation
|
|
You can find the current NuttX documentation on the [Documentation Page](https://nuttx.apache.org/docs/latest/).
|
|
|
|
Alternatively, you can build the documentation yourself by following the Documentation Build [Instructions](https://nuttx.apache.org/docs/latest/contributing/documentation.html).
|
|
|
|
The old NuttX documentation is still available in the [Apache wiki](https://cwiki.apache.org/NUTTX/NuttX).
|
|
|
|
## 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.
|
|
|
|
## 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.
|
|
|
|
## 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.
|