diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 24 insertions, 10 deletions
@@ -4,21 +4,35 @@ Code under this directory is not part of the core ChibiOS project and the copyright is retained by the original authors. See copyright notes in file headers. -Code is maintained via Github https://github.com/ChibiOS/ChibiOS-Contrib -Feel free to send pull request there. +Code is maintained via Github: https://github.com/ChibiOS/ChibiOS-Contrib +Feel free to open pull request there. #### Using -```bash -# git clone git@github.com:Chibios/ChibiOS.git ChibiOS-RT -# git clone git@github.com:ChibiOS/ChibiOS-Contrib.git ChibiOS-Contrib +Default makefiles assume this repo will be cloned in the same folder as ChibiOS. +If you use another location, you will have to edit the Makefile, or specify an alternate location to make, ie: + +``` +cd ChibiOS-Contrib/testhal/STM32/STM32F3xx/TIMCAP +make CHIBIOS=~/src/ChibiOS ``` -Note: this repos cloned in the same directory side by side (not inside). -#### Useful links +A good way to use it is to clone it as a submodule inside your project: + +``` +git submodule add https://github.com/ChibiOS/ChibiOS.git +git submodule add https://github.com/ChibiOS/ChibiOS-Contrib.git +``` -https://help.github.com/ +#### Contributing -http://git-scm.com/ +When you submit a pull request, make sure all modified platform tests compile using the tools/build.sh script. +There is an automated check that will report errors if it doesn't. +Feel free to update authors.txt with your name. + +#### Useful links -http://chibios.org/dokuwiki/doku.php?id=chibios:guides:style_guide +https://help.github.com/ +http://git-scm.com/ +http://chibios.org/dokuwiki/doku.php?id=chibios:guides:style_guide +http://www.chibios.com/forum/ |