diff --git a/README.md b/README.md index 5dd770c..12229c6 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,22 @@ worked on. - [ ] AVR - [ ] armv6 - [ ] armv7 + + +## Usage + +1. Download the master repo(superrepo) +2. cd into the directory. +3. check out the newest release tag. +4. fetch the git sub-modules or templates as desired. +5. read the readme in the sub-module/template + +```sh +git clone ssh://git@gorge.works:30023/TDD-For-Rust/tdd_templates.git +cd tdd_templates + +# Updates and clones for all submodules. +git submodule update --init +``` + +