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

doc: update development to makefile

This commit is contained in:
King Kévin 2022-06-24 18:00:49 +02:00
parent cb7aa78b06
commit cafca73743
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
DEVELOPMENT.md
View File

@ -5,7 +5,7 @@ requirements
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)
- make: takes care of generating the output files
- [QEDA](http://qeda.org/): to generate footprints for the parts
- [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
@ -16,7 +16,7 @@ to be able to generate the outputs, you need following software:
compiling
=========
to generate schematic, BoM, board render, and fabrication output, run `rake`.
to generate schematic, BoM, board render, and fabrication output, run `make`.
library
-------
@ -39,7 +39,7 @@ sudo npm install --global
to generate the parts:
~~~
rake library
make lib
~~~
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 +55,7 @@ most symbols are generated by QEDA as described above.
to export as pdf:
~~~
rake print
make print
~~~
BOM
@ -63,7 +63,7 @@ BOM
to export the bill of material (as CSV):
~~~
rake bom
make bom
~~~
board
@ -73,11 +73,11 @@ the `.kicad_brd` file is the board layout source file.
it has been drawn using the [KiCAD pcbnew](https://docs.kicad.org/6.0/en/pcbnew/pcbnew.html) PCB editor.
it uses the footprints from the `kicad/` folder.
most symbols are generated by QEDA as described above.
most footprints are generated by QEDA as described above.
to export gerber files for PCB manufacturer (and photo preview + overview document):
~~~
rake fabrication
make fabrication
~~~
versioning
@ -86,8 +86,7 @@ versioning
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.
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`
- `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