|
|
|
Everything you always wanted to know about Boardcore but you were afraid to ask.
|
|
|
|
Boardcore is an evolving project to which many have contributed over the years, each with his own style and ideas.
|
|
|
|
|
|
|
|
### Coding Guidelines
|
|
|
|
Some of the things that you will find can be perfectioned, some other have to be changed and some might not even been used or documented at all.
|
|
|
|
|
|
|
|
Nothing is written in stone, so if you'd like to contribute with your own discoveries and suggestions, you're more than welcome!
|
|
|
|
|
|
|
|
### Basic Workflow
|
|
|
|
*Read this before you start coding*
|
|
|
|
|
|
|
|
- [Git Workflow](https://github.com/skyward-er/skyward-boardcore/wiki/Git-Workflow)
|
|
|
|
- [Codestyle Rules](https://github.com/skyward-er/skyward-boardcore/wiki/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)
|
|
|
|
- [Coding Guidelines](https://github.com/skyward-er/skyward-boardcore/wiki/Coding-Guidelines)
|
|
|
|
- [Best Practices (TODO)](): Terraneo's examples on multi threading
|
|
|
|
|
|
|
|
### Guides
|
|
|
|
### Guides
|
|
|
|
*Things that will help you getting familiar with Boardcore*
|
|
|
|
|
|
|
|
- [Eclipse Configuration (TODO)](https://github.com/skyward-er/skyward-boardcore/wiki/Eclipse-Configuration)
|
|
|
|
- [IDE 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)
|
|
|
|
- [Running on a Discovery](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
|
| ... | ... | @@ -34,5 +36,4 @@ Everything you always wanted to know about Boardcore but you were afraid to ask. |
|
|
|
|
|
|
|
* [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 |
|
|
|
* [Official Skyward docs](https://github.com/skyward-er/elc-internal-reports/tree/master/Software) |
|
|
\ No newline at end of file |
