summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Palsson <karlp@tweak.net.au>2018-08-29 14:03:22 +0000
committerKarl Palsson <karlp@tweak.net.au>2018-08-29 14:03:22 +0000
commit4c1b3e2bf4b7b07c428ee75e43320d94f04016f2 (patch)
tree9fb120d49cc36b29b9a7a22aebc219b3094247f4
parentf5cea063638dd417cd45706b0035d33759daabbc (diff)
downloadstm32f103c8-examples-4c1b3e2bf4b7b07c428ee75e43320d94f04016f2.tar
stm32f103c8-examples-4c1b3e2bf4b7b07c428ee75e43320d94f04016f2.tar.zst
stm32f103c8-examples-4c1b3e2bf4b7b07c428ee75e43320d94f04016f2.zip
Clarify readme further for getting started
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 964b8de..06938cc 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,15 @@
-Easy clone and go repository for a libopencm3 based project.
+Easy "clone and go" repository for a libopencm3 based project.
-my-project contains your application
-my-common-code contains something shared.
+# Instructions
+ 1. git clone https://github.com/libopencm3/libopencm3-template.git your-project
+ 2. cd your-project
+ 3. git submodule update --init (Only needed once)
+ 4. make -C my-project
+# Directories
+* my-project contains your application
+* my-common-code contains something shared.
+
+# As a template
You should replace this with your _own_ README if you are using this
as a template.