diff --git a/readme.md b/readme.md index 099a3c6..2a87341 100644 --- a/readme.md +++ b/readme.md @@ -1,16 +1,16 @@ # TL,DR: -hellen-one is a toolset to produce custom PCBs by merging gerber files of known proven functional modules into trivial _frame_ PCB with mostly just the main vehicle connector. Gerber merging happens in the cloud, i.e. on the github server. +hellen-one is a toolset to produce custom PCBs by merging gerber files of known proven functional modules into trivial _frame_ PCB with mostly just the main vehicle connector. Gerber export and gerber merging happens in the cloud, i.e. on the github server. Step 1: fork https://github.com/rusefi/hellen-example/ repo to get github actions and meta files [learn about forking](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) Step 2: make sure github actions are enabled/enable github actions on your fork -Step 3: replace xxx and yyy in ``revision.txt`` with name of your board +Step 3: replace xxx and yyy in ``revision.txt`` with name of your board. By the way we expect kicad files to be placed in the root folder of the repository. Step 4: create youboard.kicad_pcb from [proven modules](https://github.com/andreika-git/hellen-one/tree/master/modules) using KiCAD -Step 5: push into github to trigger hellen-one gerber expert and gerber merge (that's where the hellen magic happens! for instance gerber export is taken care +Step 5: push into github to trigger hellen-one gerber _expert_ and gerber _merge_ (that's where the hellen magic happens! for instance gerber export is taken care by [export.sh](https://github.com/andreika-git/hellen-one/blob/master/kicad/bin/export.sh) script which github action would invoke _automatically_. Just watch for the yellow circle to turn into a green checkmark.) Step 6: (sorry rotation only by factor of 90 degrees at this point)