Skip to content

Commit 2484e21

Browse files
cederomxiaoxiang781216
authored andcommitted
index: Update front page with first-glance information.
* Most important information is available on the front page at first-glance. * Added missing Discord link reference. Signed-off-by: Tomasz 'CeDeROM' CEDRO <[email protected]>
1 parent e599c23 commit 2484e21

File tree

2 files changed

+48
-11
lines changed

2 files changed

+48
-11
lines changed

_data/project.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ source_repository_os: https://gitbox.apache.org/repos/asf?p=nuttx.git
5454
source_repository_os_mirror: https://github.com/apache/nuttx
5555
source_repository_apps: https://gitbox.apache.org/repos/asf?p=nuttx-apps.git
5656
source_repository_apps_mirror: https://github.com/apache/nuttx-apps
57+
source_repository_website: https://gitbox.apache.org/repos/asf?p=nuttx-website.git
58+
source_repository_website_mirror: https://github.com/apache/nuttx-website
5759

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

65-
socialmedia_youtube: https://www.youtube.com/@nuttxchannel
66-
socialmedia_reddit: https://www.reddit.com/r/nuttx/
67+
socialmedia_discord: https://discord.gg/YaqhJjHF95
6768
socialmedia_hackster: https://www.hackster.io/nuttx
6869
socialmedia_linkedin_company: https://www.linkedin.com/company/nuttx
6970
socialmedia_linkedin_group: https://www.linkedin.com/groups/12002792
71+
socialmedia_reddit: https://www.reddit.com/r/nuttx/
72+
socialmedia_youtube: https://www.youtube.com/@nuttxchannel

index.md

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,57 @@ limitations under the License.
2727

2828
## Apache NuttX
2929

30-
NuttX is a real-time operating system (RTOS) with an emphasis on standards
31-
compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller
32-
environments, the primary governing standards in NuttX are POSIX and ANSI
33-
standards. Additional standard APIs from Unix and other common RTOS's (such as
34-
VxWorks) are adopted for functionality not available under these standards, or
35-
for functionality that is not appropriate for deeply-embedded environments (such
36-
as fork()).
30+
NuttX is a free and open-source (FOSS) real-time operating system (RTOS)
31+
with an emphasis on standards compliance and small footprint.
32+
Scalable from 8-bit to 64-bit microcontroller environments,
33+
the primary governing standards in NuttX are POSIX and ANSI standards.
34+
Additional standard APIs from Unix and other common RTOS's (such as VxWorks)
35+
are adopted for functionality not available under these standards,
36+
or for functionality that is not appropriate for deeply-embedded environments
37+
(such as fork()).
38+
39+
40+
## Get NuttX
41+
42+
Release packages are available [here]({{ site.baseurl }}/download).
43+
We use three GIT repositories to develop the project:
44+
[RTOS]({{ site.data.project.source_repository_os_mirror }}),
45+
[Applications]({{ site.data.project.source_repository_apps_mirror }}),
46+
and [Website]({{ site.data.project.source_repository_website_mirror }}).
47+
Documentation is part of the RTOS repository and then built and hosted online.
48+
49+
50+
## Join Us
51+
52+
NuttX is developed and maintained by an international
53+
[group of volunteers]({{ site.baseurl }}/community-members) from all around the
54+
world. Please take a look at our [community]({{ site.baseurl }}/community)
55+
page to see how to join us and contribute to the project.
56+
57+
[Mailing list]({{ site.data.project.dev_list_archive_mailarchive }}) is our
58+
main communication channel, but we are also present on various social media
59+
platforms such as
60+
[Discord]({{ site.data.project.socialmedia_discord }}),
61+
[Hackster]({{ site.data.project.socialmedia_hackster }}),
62+
[LinkedIn]({{ site.data.project.socialmedia_linkedin_company }}),
63+
[Reddit]({{ site.data.project.socialmedia_reddit }}).
64+
65+
[NuttX Channel on YouTube]({{ site.data.project.socialmedia_youtube }}) contains
66+
many demos, tutorials, and hands-on exercises, as well as events videos.
3767

3868

3969
## Documentation
4070

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

4374

4475
## Online Demo
4576

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

4882

4983
## Community Events

0 commit comments

Comments
 (0)