From 4c1b3e2bf4b7b07c428ee75e43320d94f04016f2 Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Wed, 29 Aug 2018 14:03:22 +0000 Subject: Clarify readme further for getting started --- README.md | 14 +++++++++++--- 1 file 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. -- cgit v1.2.3-70-g09d2