introducing hellen-example

This commit is contained in:
rusefillc 2023-12-04 15:05:31 -05:00
parent c218e68be1
commit f10cb6c15e
2 changed files with 26 additions and 18 deletions

16
readme-manual-process.md Normal file
View File

@ -0,0 +1,16 @@
* * *
docker approach like in most of the sample repos is recommended. If you would rather run these scripts locally, you need a 'bash' environment available natively as Unix/Linux shells.
Or, under Windows, you'll need to install a special environment like MSYS2 (https://www.msys2.org) or Cygwin (https://www.cygwin.com)
Please see "create_hellen_board_example.sh" for basic script usage.
* * *
- ./bin
* contains scripts needed to compile a ready-to-fab board file, including: Gerber, BOM+CPL files, board images
- ./modules
* contains ready-to-use modules
- ./ibom-data
* contains a customized footprint library used by iBom generator. Don't use these files for your pcb
- ./create_hellen_board_example.sh
* is a simple example of using Hellen-One scripts for your own board.

View File

@ -1,12 +1,20 @@
TL,DR: please see how some of the open source boards are done and follow the pattern!
TL,DR:
* fork https://github.com/rusefi/hellen-example/ repo to get github actions and meta files
* replace xxx and yyy in ``revision.txt`` with name of your board
* create youboard.kicad_pcb using KiCAD 6 or 7
* push into github to trigger hellen-one gerber expert and gerber merge (that's where the hellen magic happens!)
* order your using fabrication files from 'boards' folder!
Please see how some of the open source boards are done and follow the pattern:
* https://github.com/rusefi/alphax-4chan
* https://github.com/rusefi/uaefi
* https://github.com/rusefi/alphax-2chan
* https://github.com/rusefi/hellen154hyundai
* https://github.com/rusefi/hellen121vag
* https://github.com/rusefi/hellen88bmw
* https://github.com/andreika-git/hellen81/
* https://github.com/rusefi/alphax-8chan
This repository contains all scripts and data to create Hellen One boards for [rusEFI](https://github.com/rusefi/rusefi)!
@ -23,19 +31,3 @@ Please see Hellen One Wiki for more info:
https://github.com/andreika-git/hellen-one/wiki
* * *
docker approach like in most of the sample repos is recommended. If you would rather run these scripts locally, you need a 'bash' environment available natively as Unix/Linux shells.
Or, under Windows, you'll need to install a special environment like MSYS2 (https://www.msys2.org) or Cygwin (https://www.cygwin.com)
Please see "create_hellen_board_example.sh" for basic script usage.
* * *
- ./bin
* contains scripts needed to compile a ready-to-fab board file, including: Gerber, BOM+CPL files, board images
- ./modules
* contains ready-to-use modules
- ./ibom-data
* contains a customized footprint library used by iBom generator. Don't use these files for your pcb
- ./create_hellen_board_example.sh
* is a simple example of using Hellen-One scripts for your own board.