Skip to content

index: Update front page with first-glance information. #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 26, 2025
Merged

index: Update front page with first-glance information. #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions _data/project.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ source_repository_os: https://gitbox.apache.org/repos/asf?p=nuttx.git
source_repository_os_mirror: https://github.com/apache/nuttx
source_repository_apps: https://gitbox.apache.org/repos/asf?p=nuttx-apps.git
source_repository_apps_mirror: https://github.com/apache/nuttx-apps
source_repository_website: https://gitbox.apache.org/repos/asf?p=nuttx-website.git
source_repository_website_mirror: https://github.com/apache/nuttx-website

website_repository: https://gitbox.apache.org/repos/asf?p=nuttx-website.git
website_repository_mirror: https://github.com/apache/nuttx-website
Expand All @@ -62,8 +64,9 @@ community_events: https://events.nuttx.apache.org
community_events_workshop_2025_cfp: https://docs.google.com/forms/d/e/1FAIpQLSecMK1Jt264Ykc_t6WRe0u8MYMgbGLW2ophtG-26F6zup9ppw/viewform
community_events_workshop_2025_linkedin_event: https://www.linkedin.com/company/nuttx/

socialmedia_youtube: https://www.youtube.com/@nuttxchannel
socialmedia_reddit: https://www.reddit.com/r/nuttx/
socialmedia_discord: https://discord.gg/YaqhJjHF95
socialmedia_hackster: https://www.hackster.io/nuttx
socialmedia_linkedin_company: https://www.linkedin.com/company/nuttx
socialmedia_linkedin_group: https://www.linkedin.com/groups/12002792
socialmedia_reddit: https://www.reddit.com/r/nuttx/
socialmedia_youtube: https://www.youtube.com/@nuttxchannel
52 changes: 43 additions & 9 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,57 @@ limitations under the License.

## Apache NuttX

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 RTOS's (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()).
NuttX is a free and open-source (FOSS) 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 RTOS's (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()).


## Get NuttX

Release packages are available [here]({{ site.baseurl }}/download).
We use three GIT repositories to develop the project:
[RTOS]({{ site.data.project.source_repository_os_mirror }}),
[Applications]({{ site.data.project.source_repository_apps_mirror }}),
and [Website]({{ site.data.project.source_repository_website_mirror }}).
Documentation is part of the RTOS repository and then built and hosted online.


## Join Us

NuttX is developed and maintained by an international
[group of volunteers]({{ site.baseurl }}/community-members) from all around the
world. Please take a look at our [community]({{ site.baseurl }}/community)
page to see how to join us and contribute to the project.

[Mailing list]({{ site.data.project.dev_list_archive_mailarchive }}) is our
main communication channel, but we are also present on various social media
platforms such as
[Discord]({{ site.data.project.socialmedia_discord }}),
[Hackster]({{ site.data.project.socialmedia_hackster }}),
[LinkedIn]({{ site.data.project.socialmedia_linkedin_company }}),
[Reddit]({{ site.data.project.socialmedia_reddit }}).

[NuttX Channel on YouTube]({{ site.data.project.socialmedia_youtube }}) contains
many demos, tutorials, and hands-on exercises, as well as events videos.


## Documentation

Extensive documentation can be found [here]({{ site.baseurl }}/docs/latest).
Full project documentation can be found [here]({{ site.baseurl }}/docs/latest).
Scientific papers are [here]({{ site.baseurl }}/articles).


## Online Demo

Try the online demo [here]({{ site.baseurl }}/demo).
NuttX is incredibly portable. It runs on over 15 different CPU architectures,
over 300 popular embedded hardware boards and development kits, provides
more than 1500 ready to use firmware configuration templates for your project.
See yourself, try out the [NuttX WebAssembly demo]({{ site.baseurl }}/demo).


## Community Events
Expand Down