|
*TODO everything: decide style conventions, write design best practices and start adding examples*
|
|
*TODO decide style conventions, write design best practices and start adding examples*
|
|
|
|
|
|
### First Steps
|
|
### First Steps
|
|
* [SBS Quick Guide](https://github.com/skyward-er/skyward-boardcore/wiki/SBS-Quick-Guide)
|
|
* [SBS Quick Guide](https://github.com/skyward-er/skyward-boardcore/wiki/SBS-Quick-Guide)
|
|
* [Writing a Driver](https://github.com/skyward-er/skyward-boardcore/wiki/Writing-a-driver)
|
|
* [Writing a Driver](https://github.com/skyward-er/skyward-boardcore/wiki/Writing-a-driver)
|
|
* [Eclipse configuration]()
|
|
* [Eclipse configuration (TODO)](https://github.com/skyward-er/skyward-boardcore/wiki/Eclipse-configuration)
|
|
* [Flashing on a Discovery board]()
|
|
* [Flashing on a Discovery board](https://github.com/skyward-er/skyward-boardcore/wiki/Flashing-on-a-Discovery-board)
|
|
* [Flashing on a Stormtrooper]()
|
|
* [Flashing on a Stormtrooper (TODO)](https://github.com/skyward-er/skyward-boardcore/wiki/Flashing-on-a-Stormtrooper)
|
|
|
|
|
|
### Coding Rules & Best Practices
|
|
### Coding Rules & Best Practices
|
|
* Code style and naming conventions
|
|
* [Code style and naming conventions (TODO)]()
|
|
* Git rules: [branching](http://nvie.com/posts/a-successful-git-branching-model/), commit messages style
|
|
* [Git rules (TODO)]: branching like [this](http://nvie.com/posts/a-successful-git-branching-model/), commit messages style
|
|
|
|
|
|
* Best Practices: *general design rules that you should follow in order to write bomb-proof code*
|
|
* Best Practices: *general design rules that you should follow in order to write bomb-proof code*
|
|
- [Terraneo's examples on multi threading]
|
|
- [Terraneo's examples on multi threading (TODO)]()
|
|
- [NASA coding principles](http://pixelscommander.com/wp-content/uploads/2014/12/P10.pdf) (revisited)
|
|
- [NASA coding principles](http://pixelscommander.com/wp-content/uploads/2014/12/P10.pdf) (revisited)
|
|
|
|
|
|
### Examples
|
|
### Useful stuff
|
|
* Common examples: *Things that you are very likely to need when writing code in boardcore*
|
|
* Common examples: *Things that you are very likely to need when writing code in boardcore*
|
|
- data logging (debugging)
|
|
- data logging (debugging)
|
|
- active objects (scheduling)
|
|
- active objects (scheduling)
|
... | | ... | |