|
|
Coding Rules & Best Practices
|
|
|
------------
|
|
|
TODO *everything*: decide style conventions, write design best practices and start adding examples
|
|
|
*TODO everything: decide style conventions, write design best practices and start adding examples*
|
|
|
|
|
|
### First Steps
|
|
|
* [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)
|
|
|
* [Eclipse configuration]()
|
|
|
* [Flashing on a Discovery board]()
|
|
|
* [Flashing on a Stormtrooper]()
|
|
|
|
|
|
### Coding Rules & Best Practices
|
|
|
* Code style and naming conventions
|
|
|
* Git rules: [branching](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*
|
|
|
- Terraneo's examples on multi threading
|
|
|
- [Terraneo's examples on multi threading]
|
|
|
- [NASA coding principles](http://pixelscommander.com/wp-content/uploads/2014/12/P10.pdf) (revisited)
|
|
|
|
|
|
Quick Guides
|
|
|
----------------
|
|
|
* SBS
|
|
|
* Writing a Driver
|
|
|
* Eclipse
|
|
|
* Flashing on a Discovery
|
|
|
* Flashing on a Stormtrooper
|
|
|
|
|
|
Examples
|
|
|
--------
|
|
|
### Examples
|
|
|
* Common examples: *Things that you are very likely to need when writing code in boardcore*
|
|
|
- Read from and Write to serial (other than default)
|
|
|
- data logging (debugging)
|
|
|
- active objects (scheduling)
|
|
|
- error reporting (fault counter)
|
... | ... | @@ -28,7 +25,8 @@ Examples |
|
|
- scheduler e funzioni con timeout
|
|
|
- profiling della memoria
|
|
|
|
|
|
* Cheat Sheet: *Things that made us say "If only I knew that before!" (or maybe worse)*
|
|
|
* [Cheat Sheet](https://github.com/skyward-er/skyward-boardcore/wiki/Cheat-Sheet): *Things that made us say "If only I knew that before!" (or worse)*
|
|
|
- USART read/write in Miosix
|
|
|
- Add another usart to a board
|
|
|
- Use right amount of stack (printf!)
|
|
|
- Chiamare una funzione di un oggetto in un thread (wrapper statico) |
|
|
\ No newline at end of file |