Skip to content

Commit e270a40

Browse files
committed
Improve install documentation.
1 parent 0b763a2 commit e270a40

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

build/INSTALL.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@ INSTALL COSA CUSTOM BOARDS
2323
==========================
2424

2525
1. Download custom board support and install in sketchbook hardware
26-
directory.
26+
directory. The command line build assumes that they are installed
27+
with 1.0.X directory structure (i.e. without the avr level).
2728

2829
2. Add symbolic link in COSA_DIR/variants to custom board variants.
2930
Example for Cosa-CustomBoard template.
3031
$ ln -s $SKETCHBOOK/hardware/CustomBoard/variants/VENDOR $COSA_DIR/variants
3132

32-
3. Verify that the custom board is now available.
33+
3. Verify that the custom board is now available. The following
34+
commands will generate and print the list of boards.
3335
$ cd $COSA_DIR/build
3436
$ cosa boards

doc/02-install.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,25 @@ https://raw.githubusercontent.com/mikaelpatel/Cosa/master/package_cosa_index.jso
1313

1414
## Via GIT
1515

16+
For Arduino 1.0.X:
1617
```shell
1718
cd <custom_path>/sketchbook
18-
mkdir hardware # Create the hardware folder if missing
19+
mkdir hardware
1920
cd hardware
2021
git clone https://github.com/mikaelpatel/Cosa.git
2122
```
2223

24+
For Arduino 1.5.x and higher an extra avr directory level is needed:
25+
```shell
26+
cd <custom_path>/sketchbook
27+
mkdir hardware
28+
cd hardware
29+
mkdir Cosa
30+
cd Cosa
31+
git clone https://github.com/mikaelpatel/Cosa.git
32+
mv Cosa avr
33+
```
34+
2335
Then you can update the library by using:
2436

2537
```shell

0 commit comments

Comments
 (0)