doc: replace rake with make
This commit is contained in:
parent
e787a3412e
commit
4636a6508b
@ -5,7 +5,6 @@ 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)
|
||||
- [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 +15,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
|
||||
-------
|
||||
@ -25,11 +24,13 @@ almost all of the symbols and footprints used in the schematic and board layout
|
||||
the `library` folder contains the QEDA parts definitions.
|
||||
|
||||
to install QEDA using NPM from the official repository:
|
||||
|
||||
~~~
|
||||
sudo npm install -g qeda
|
||||
~~~
|
||||
|
||||
to install QEDA from the sources:
|
||||
|
||||
~~~
|
||||
git clone https://github.com/qeda/qeda
|
||||
cd qeda
|
||||
@ -38,8 +39,9 @@ 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.
|
||||
@ -54,16 +56,18 @@ it uses standard symbols, and the ones in the `kicad/` folder.
|
||||
most symbols are generated by QEDA as described above.
|
||||
|
||||
to export as pdf:
|
||||
|
||||
~~~
|
||||
rake print
|
||||
make print
|
||||
~~~
|
||||
|
||||
BOM
|
||||
---
|
||||
|
||||
to export the bill of material (as CSV):
|
||||
|
||||
~~~
|
||||
rake bom
|
||||
make bom
|
||||
~~~
|
||||
|
||||
board
|
||||
@ -76,8 +80,9 @@ it uses the footprints from the `kicad/` folder.
|
||||
most symbols 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 +91,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
|
||||
|
Loading…
Reference in New Issue
Block a user