|
|
*TODO decide style conventions, write design best practices and start adding examples*
|
|
|
Everything you always wanted to know about Boardcore but you were afraid to ask.
|
|
|
|
|
|
### First Steps
|
|
|
* [Eclipse configuration (TODO)](https://github.com/skyward-er/skyward-boardcore/wiki/Eclipse-configuration)
|
|
|
* [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)
|
|
|
* [Flashing on a Discovery board](https://github.com/skyward-er/skyward-boardcore/wiki/Flashing-on-a-Discovery-board)
|
|
|
* [Flashing on a Stormtrooper (TODO)](https://github.com/skyward-er/skyward-boardcore/wiki/Flashing-on-a-Stormtrooper)
|
|
|
### Contributing Rules
|
|
|
*Read this before you start coding*
|
|
|
|
|
|
### Coding Rules & Best Practices
|
|
|
* [Code style and naming conventions (TODO)]()
|
|
|
* [Git rules (TODO)](): branching like [this](http://nvie.com/posts/a-successful-git-branching-model/), commit messages style
|
|
|
|
|
|
* [Design Rules and Best Practices (TODO)](): *general design rules that you should follow in order to write bomb-proof code*
|
|
|
- [Git Workflow](https://github.com/skyward-er/skyward-boardcore/wiki/Git-Workflow)
|
|
|
- [Codestyle Rules](https://github.com/skyward-er/skyward-boardcore/wiki/General-Codestyle)
|
|
|
- [Design Best Practices (TODO)]():
|
|
|
- Terraneo's examples on multi threading
|
|
|
- [NASA coding principles](http://pixelscommander.com/wp-content/uploads/2014/12/P10.pdf) (revisited)
|
|
|
|
|
|
Examples
|
|
|
------------
|
|
|
* Common examples: *Things that you are very likely to need when writing code in boardcore*
|
|
|
- data logging (debugging)
|
|
|
- active objects (scheduling)
|
|
|
- singleton
|
|
|
- error reporting (fault counter)
|
|
|
- miosix queues
|
|
|
- miosix threads
|
|
|
- scheduler e funzioni con timeout
|
|
|
- profiling della memoria
|
|
|
|
|
|
* [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)* |
|
|
\ No newline at end of file |
|
|
### Guides
|
|
|
*Things that will help you getting familiar with Boardcore*
|
|
|
|
|
|
- [Eclipse Configuration (TODO)](https://github.com/skyward-er/skyward-boardcore/wiki/Eclipse-Configuration)
|
|
|
- [Writing a Driver](https://github.com/skyward-er/skyward-boardcore/wiki/Writing-a-driver)
|
|
|
- [Flashing on a Board](https://github.com/skyward-er/skyward-boardcore/wiki/Flashing-on-a-Target-Board)
|
|
|
- [**Cheat Sheet**](https://github.com/skyward-er/skyward-boardcore/wiki/Cheat-Sheet)
|
|
|
|
|
|
### Boardcore Components
|
|
|
*Specific documentation about commonly used features*
|
|
|
|
|
|
- [Skyward Build System](https://github.com/skyward-er/skyward-boardcore/wiki/Skyward-Build-Systems-(SBS))
|
|
|
- [Logger]
|
|
|
- [Scheduler]
|
|
|
- [Active Objects]
|
|
|
- [Singleton objects]
|
|
|
- [Fault Counters]
|
|
|
- [BusTemplate]
|
|
|
- [Serialization]
|
|
|
|
|
|
-----------------------------------
|
|
|
### Useful External Links
|
|
|
|
|
|
* [Miosix Wiki](https://miosix.org/wiki/index.php?title=Main_Page) for the installation.
|
|
|
* [Miosix Doxygen](https://miosix.org/doxygen/doxygen_k2.01/index.html) for the full documentation (classes, constants ecc).
|
|
|
* [ELC Handbook](https://github.com/skyward-er/elc-internal-reports/tree/master/The%20ELC%20Handbook)
|
|
|
* [Wiki di skyward](todo) |
|
|
\ No newline at end of file |