submodule doc

This commit is contained in:
Rich Holmes 2021-08-27 09:23:50 -04:00
parent a22bca6d29
commit f5fc556ca2

View file

@ -2,14 +2,22 @@ This is a work in progress; better README to come soon. Meanwhile:
**Untested hardware and software — Do not assume anything works!**
Repo uses submodules aoKicad and Kosmo_panel. To clone:
Repo uses submodules aoKicad and Kosmo\_panel. To clone:
```
git clone git@github.com:holmesrichards/WaveShaper.git
git clone git@github.com:holmesrichards/precadsr.git
git submodule init
git submodule update
```
Alternatively do
```
git clone --recurse-submodules git@github.com:holmesrichards/precadsr.git
```
Or if you download the repository as a zip file, you must also click on the "aoKicad" and "Kosmo\_panel" links on the GitHub page (they'll have "@ something" after them) and download them as separate zip files which you can unzip into the aoKicad and Kosmo\_panel directories.
If desired, copy the files from aoKicad and Kosmo\_panel to wherever you prefer (your KiCad user library directory, for instance, if you have one). Then in KiCad, add symbol libraries
```