diff --git a/README-git.md b/README-git.md deleted file mode 100644 index 3cfc241b..00000000 --- a/README-git.md +++ /dev/null @@ -1,63 +0,0 @@ -Quick start: -============ - -Assume you already have a github account. Lets your account name is -"username". - -First you need to fork 2 repos: -- ChibiOS -- ChibiOS-contrib - -Make local clone of your fork -```bash -# git clone git@github.com:username/ChibiOS.git -``` - -Make local branch for your feature -```bash -# cd ChibiOS -# git branch feature -# git checkout feature -``` - -There is no code from ChibiOS-contrib in your repo. We have to connect -ChibiOS-contrib as a git submodule -```bash -# git submodule add git@github.com:username/ChibiOS-Contrib.git community -``` - -Make branch again, but now in freshly connected submodule -```bash -# cd community -# git branch feature -# git checkout feature -``` - -Hack, hack, hack... Commit our changes and push to server. Note: you have -to do this for both repositories. First ChibiOS-Contrib -```bash -# cd community -# git add . -# git commit -m "Feature implemented" -# git push origin feature:feature -``` - -Now for parent repo -```bash -# cd .. -# git add . -# git commit -m "Feature implemented" -# git push origin feature:feature -``` - -Now all your changes published on github. Just use web interface to send -2 pull requests: for ChibiOS-contrib and for ChibiOS. - -Links: -====== - -https://help.github.com/ - -http://git-scm.com/ - -http://chibios.org/dokuwiki/doku.php?id=chibios:guides:style_guide diff --git a/README.md b/README.md index 924aba76..913b1e74 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,19 @@ notes in file headers. Code is maintained via Github https://github.com/ChibiOS/ChibiOS-Contrib Feel free to send 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 +``` +Note: this repos cloned in the same directory side by side (not inside). + +#### Useful links + +https://help.github.com/ + +http://git-scm.com/ + +http://chibios.org/dokuwiki/doku.php?id=chibios:guides:style_guide