-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added rosplane dev guide overview as a landing page
- Loading branch information
1 parent
8bdd037
commit 7a8626d
Showing
1 changed file
with
20 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,20 @@ | ||
# ROSplane Developer Guide Overview | ||
# ROSplane Developer Guide Overview | ||
|
||
The purpose of the this section is to provide detailed information on each of the components of ROSplane, as shown in the below figure. | ||
It is written with the intent that a user might know how to change each component of ROSplane, not only just how to use it. | ||
|
||
Note that the sections not part of ROSplane are not included in this section (ROSflight firmware, physical aircraft setup, etc.). | ||
|
||
|
||
| ![Diagram of ROSplane architecture](../../assets/ROSplane-overview.svg "ROSplane architecture") | | ||
|:--:| | ||
|*Diagram of the ROSplane architecture*| | ||
|
||
Each of these components are described in detail in this section, but the implementation is not fully described. | ||
Please refer to the code for more detailed information on the actual implementation of each of the elements shown above. | ||
|
||
## Contributing to ROSplane | ||
|
||
If you create a new "module" when using ROSplane for your application, please contribute back! | ||
While changes won't be included in the core ROSplane stack (see [ROSflight Vision](../../index.md#our-vision)), we hope to build a repository of modules and projects that have been created by others. | ||
Doing this is also an effective way to share your work and help others build on it. |