From 609a1cd9c48d90d8331a325f65b05cf5c9db59b1 Mon Sep 17 00:00:00 2001 From: Fabien Poussin Date: Tue, 12 Mar 2019 10:54:24 +0100 Subject: Edited Readme for path changes --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d0ed018..6414aa5 100644 --- a/README.md +++ b/README.md @@ -4,25 +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 +``` + +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 ``` -Note: this repos cloned in the same directory side by side (not inside). #### Contributing -When you submit a pull request, make sure all impacted platform tests compile using the tools/build.sh script. +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 https://help.github.com/ http://git-scm.com/ -http://chibios.org/dokuwiki/doku.php?id=chibios:guides:style_guide +http://chibios.org/dokuwiki/doku.php?id=chibios:guides:style_guide +http://www.chibios.com/forum/ -- cgit v1.2.3