Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rusefillc authored Jul 25, 2024
1 parent 5852084 commit 84c1ef0
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,20 @@

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.

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)
2: make sure github actions are enabled/enable github actions on your fork
3: replace xxx and yyy in ``revision.txt`` with name of your board
4: create youboard.kicad_pcb from [proven modules](https://github.com/andreika-git/hellen-one/tree/master/modules) using KiCAD
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.)
6: (sorry rotation only by factor of 90 degrees at this point)
7: order your using fabrication files from 'boards' folder!
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 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 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)

Step 7: order your using fabrication files from 'boards' folder!

Please see how some of the open source boards are done and follow the pattern:

Expand Down

0 comments on commit 84c1ef0

Please sign in to comment.