You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2020/04/24 16:37:41 UTC

[GitHub] [incubator-nuttx] xiaoxiang781216 commented on a change in pull request #860: README.txt: Address issues raised in -RC0 review

xiaoxiang781216 commented on a change in pull request #860:
URL: https://github.com/apache/incubator-nuttx/pull/860#discussion_r414710076



##########
File path: README.txt
##########
@@ -38,6 +46,132 @@ README
     - Window Native Toolchain Issues
   o Documentation
 
+INTRODUCTION
+^^^^^^^^^^^^
+
+  Apache NuttX (Incubating) is a real-time operating system (RTOS) with an
+  emphasis on standards compliance and small footprint.  Scalable from 8-bit
+  to 32-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()).
+
+  Extensive documentation can be found on the project wiki:
+
+    https://cwiki.apache.org/NUTTX/Nuttx
+
+Incubation Status
+-----------------
+
+  Apache NuttX (Incubating) is an effort undergoing Incubation at The Apache
+  Software Foundation (ASF), sponsored by the Incubator.  For more on our
+  incubation effort, please see the file DISCLAIMER-WIP, in the same
+  directory as this README.
+
+  For brevity, the rest of this file will refer to it as Apache NuttX or
+  simply NuttX.
+
+COMMUNITY
+^^^^^^^^^
+
+  Every volunteer project obtains its strength from the people involved in
+  it.  We invite you to participate as much or as little as you choose.
+
+  We encourage you to:
+
+  - Use our project and provide feedback.
+  - Provide us with use-cases.
+  - Report bugs and submit patches.
+  - Contribute code or documentation.
+
+Getting Help
+------------
+
+  The best place to get help is the developer's mailing list.  Please see
+  the following section:
+
+Mailing Lists
+-------------
+
+  Get help using NuttX or contribute to the project on our mailing lists:
+
+  dev@nuttx.apache.org is for people who want to contribute code to NuttX.
+
+  - To subscribe, send an email to dev-subscribe@nuttx.apache.org.
+  - To unsubscribe, send an email to dev-unsubscribe@nuttx.apache.org.
+  - View the archives at:
+
+      https://www.mail-archive.com/dev@nuttx.apache.org/
+
+  commits@nuttx.apache.org is a read-only list that notifies subscribers
+  about commit messages and patches to NuttX.
+
+  - To subscribe, send an email to commits-subscribe@nuttx.apache.org.
+  - To unsubscribe, send an email to commits-unsubscribe@nuttx.apache.org.
+  - View the archives at:
+
+      https://www.mail-archive.com/commits@nuttx.apache.org/
+
+Issue Tracker
+-------------
+
+  Bug Reports:
+
+  Found bug? Send an email to the dev list dev@nuttx.apache.org.
+
+  Before submitting an issue, please:
+
+  - Verify that the bug does in fact exist.
+  - Search the mailing list archives to verify there is no existing issue
+    reporting the bug you've found.
+  - Consider tracking down the bug yourself in the NuttX source code and
+    submitting a patch along with your bug report.  This is a great time
+    saver for the NuttX developers and helps ensure the bug will be fixed
+    quickly.
+
+  Feature Requests:
+
+  Enhancement requests for new features are also welcome. The more concrete
+  and rational the request is, the greater the chance it will incorporated
+  into future releases.
+
+Source Code
+-----------
+
+  The project sources are in two Git repositories.  The core OS is in
+  incubator-nuttx and the apps repository is in incubator-apps.  These are

Review comment:
       incubator-nuttx-apps?




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org