Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • nuttx - The real time operating system itself.
  • apps - Optional applications for the operating system. You can use this repository or make your own custom one.

REVISIT: It is very confusing to put all these three repositories. We need to define a single source to be used as base.

The main "Single Source of Truth" repositories are hosted by the ASF:

...

The repositories are mirrored at these additional read-only locations:

Cloning or Forking the Repositories

...

REVISIT: How to obtain the tarball; how to un-tar it; what steps (if any) should be taken before beginning work on customizations.

Obtaining and Setting Up a GIT Clone or Fork

REVISIT: Give detailed instructions on how to clone the repositories, and what steps to take before beginning work on customizations. (I recommend immediately creating a branch with 'git checkout -b <branch name>' .) What is the purpose of this branch?
REVIST:  Should we not recommend that people use a fork vs. a clone?  Using a clone is rather dangerous, especiailly for people with the the write bit.  One misstep could clobber the upstream master.  The fork workflow, on the other hand, keeps a remote clone from which we all can pubish chages, all committers and all contributors alike.  Reference: https://help.github.com/en/github/getting-started-with-github/fork-a-repo  Aren't these "Obtaining" paragraphs redundant?  Isn't that addressed above?  Some kind of reorganization is needed, either eliminating some redundant paragraphs or moving information from above to here.

Develop Your Changes

This document describes the workflow of how to get changes upstreamed into the official NuttX repositories. The technical details of how to develop changes are beyond the scope of this document. However, we will take this opportunity to remind you to:

...