Skip to content

Commit f1c85db

Browse files
committed
Document usage and example makefile
1 parent 2788726 commit f1c85db

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,23 @@ As a side effect of providing a scriptable plot driver for KiCad, KiPlot also
2121
allows functional testing of KiCad plot functions, which would otherwise be
2222
somewhat unwieldy to write.
2323

24-
## Developing
24+
## Using KiPlot
25+
26+
You can call `kiplot` directly, passing a PCB file and a config file:
27+
28+
```
29+
-b $(PCB) -c $(KIPLOT_CFG) -v
30+
```
31+
32+
A simple target can be added to your `makefile`, so you can just run
33+
`make pcb_files` or integrate into your current build process.
34+
35+
```
36+
pcb_files:
37+
kiplot -b $(PCB) -c $(KIPLOT_CFG) -v
38+
```
39+
40+
## Installing
2541

2642
### Set up a virtualenv (if you installed KiCad normally)
2743

0 commit comments

Comments
 (0)