kingkevin
/
board
1
0
Fork 0
Code Issues Pull Requests Projects Releases 34 Wiki Activity

doc: replace rake with make

This commit is contained in:
King Kévin 2022-08-09 14:38:39 +02:00
parent 33a4f8993f
commit d606c3c2f4
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
DEVELOPMENT.md
View File

@ -5,7 +5,6 @@ requirements
to be able to generate the outputs, you need following software: to be able to generate the outputs, you need following software:
- rake: the central script taking care of generating the output files (Makefile is too cumbersome to parse files)
- [QEDA](http://qeda.org/): to generate footprints for the parts - [QEDA](http://qeda.org/): to generate footprints for the parts
- [KiCad](https://www.kicad.org/): EDA software used for schematic capture and board layout - [KiCad](https://www.kicad.org/): EDA software used for schematic capture and board layout
- [PcbDraw](https://github.com/yaqwsx/PcbDraw): to generate board layout rendering - [PcbDraw](https://github.com/yaqwsx/PcbDraw): to generate board layout rendering
@ -16,7 +15,7 @@ to be able to generate the outputs, you need following software:
compiling compiling
========= =========
to generate schematic, BoM, board render, and fabrication output, run `rake`. to generate schematic, BoM, board render, and fabrication output, run `make`.
library library
------- -------
@ -39,7 +38,7 @@ sudo npm install --global
to generate the parts: to generate the parts:
~~~ ~~~
rake library make library
~~~ ~~~
this will use the parts definition (.yaml files) in the `library` to generate the symbols (.sym files) and footprints used by KiCAD in the `kicad` folder. this will use the parts definition (.yaml files) in the `library` to generate the symbols (.sym files) and footprints used by KiCAD in the `kicad` folder.
@ -55,7 +54,7 @@ most symbols are generated by QEDA as described above.
to export as pdf: to export as pdf:
~~~ ~~~
rake print make print
~~~ ~~~
BOM BOM
@ -63,7 +62,7 @@ BOM
to export the bill of material (as CSV): to export the bill of material (as CSV):
~~~ ~~~
rake bom make bom
~~~ ~~~
board board
@ -77,7 +76,7 @@ most symbols are generated by QEDA as described above.
to export gerber files for PCB manufacturer (and photo preview + overview document): to export gerber files for PCB manufacturer (and photo preview + overview document):
~~~ ~~~
rake fabrication make fabrication
~~~ ~~~
versioning versioning
@ -86,8 +85,7 @@ versioning
the source schematic and board layout do not include version information. the source schematic and board layout do not include version information.
when generating schematic or board fabrication output, a copy of the source files with date and version information is done as `.versioned.` files. when generating schematic or board fabrication output, a copy of the source files with date and version information is done as `.versioned.` files.
the date corresponds to the last changes (i.e. commit). the date corresponds to the last changes (i.e. commit).
the version is formatted as `v.r hhhhhhh`: the version is formatted as `v.r`:
- `v` corresponds to the major version information defined in `version` - `v` corresponds to the major version information defined in `version`
- `r` corresponds to the total number of changes done to the source files - `r` corresponds to the total number of changes done to the source files
- `hhhhhhh` corresponds to the git hash of the commit used to generate the version information