Update instructions
This commit is contained in:
parent
0ff22facca
commit
66410daa00
5
Makefile
5
Makefile
|
|
@ -1,11 +1,14 @@
|
|||
# .DELETE_ON_ERROR:
|
||||
.SECONDARY:
|
||||
.PHONY: clean all
|
||||
.PHONY: clean all setup
|
||||
.DEFAULT: all
|
||||
|
||||
container_cmd ?= docker
|
||||
container_args ?= -w /board -v $(shell pwd):/board --rm
|
||||
|
||||
setup:
|
||||
npm install
|
||||
|
||||
# outputs from
|
||||
output/pcbs/board.kicad_pcb output/pcbs/top_plate.kicad_pcb output/pcbs/bottom_plate.kicad_pcb &: samoklava.yaml
|
||||
npm run gen
|
||||
|
|
|
|||
13
README.md
13
README.md
|
|
@ -16,4 +16,15 @@ The interesting thing about this keyboard is that it's a declarative design ("sa
|
|||
* uses [kicad-automation-scripts](https://github.com/productize/kicad-automation-scripts) and [FreeRouting](https://github.com/freerouting/freerouting) to **automatically route the traces on the PCB**
|
||||
* uses [KiKit](https://github.com/yaqwsx/KiKit) to render PCB previews (see top of this file) and production-ready **Gerber files**
|
||||
|
||||
See the [Makefile](Makefile) for more details.
|
||||
## How to
|
||||
If you would like to modify this:
|
||||
* fork it
|
||||
* change `samoklava.yaml` to your liking
|
||||
* push your changes; the build it GitHub Workflow will pick it up, autoroute and generate Gerbers, all in a zip file.
|
||||
See https://github.com/soundmonster/samoklava/actions
|
||||
* or:
|
||||
* make sure to have Docker CLI and NodeJS installed
|
||||
* run `make setup clean all`
|
||||
* check the `output` folder for KiCad PCBs and Gerbers
|
||||
|
||||
See the [workflow](.github/workflows/build.yml) or the [Makefile](Makefile) for more details.
|
||||
|
|
|
|||
Loading…
Reference in New Issue