summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3508ed3..801d49f 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
Easy "clone and go" repository for a libopencm3 based project.
# Instructions
- 1. git clone https://github.com/libopencm3/libopencm3-template.git your-project
+ 1. git clone --recurse-submodules https://github.com/libopencm3/libopencm3-template.git your-project
2. cd your-project
- 3. git submodule update --init # (Only needed once)
- 4. make -C libopencm3 # (Only needed once)
- 5. make -C my-project
+ 3. make -C libopencm3 # (Only needed once)
+ 4. make -C my-project
+
+If you have an older git, or got ahead of yourself and skipped the ```--recurse-submodules```
+you can fix things by running ```git submodule update --init``` (This is only needed once)
# Directories
* my-project contains your application