summaryrefslogtreecommitdiff
path: root/README.md
blob: 801d49febaebb505cf19e2dbb3dbab8dba883a2b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Easy "clone and go" repository for a libopencm3 based project.

# Instructions
 1. git clone --recurse-submodules https://github.com/libopencm3/libopencm3-template.git your-project
 2. cd your-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
* 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.