Skip to content

Commit c22676f

Browse files
committed
Add note to README.md
1 parent fa3840e commit c22676f

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ datasheet.
1717

1818
KiPlot lets you do this.
1919

20+
As a side effect of providing a scriptable plot driver for KiCad, KiPlot also
21+
allows functional testing of KiCad plot functions, which would otherwise be
22+
somewhat unwieldy to write.
23+
2024
## Developing
2125

2226
Set up a virtualenv:
@@ -30,4 +34,23 @@ Install with `pip -e`:
3034
```
3135
cd path/to/kiplot
3236
pip install -e .
33-
```
37+
```
38+
39+
This doesn't include the `pcbnew` Python package - that is assumed to
40+
be accessible to the program. You might need to add it to the `PYTHONPATH`.
41+
42+
You might also need to set `LD_LIBRARY_PATH` (you need to be able to load
43+
`libkicad_3dsg.so`).
44+
45+
For example, if you installed in `~/local/kicad`, you might want:
46+
47+
```
48+
export PYTHONPATH=~/local/kicad/lib/python2.7/site-packages
49+
export LD_LIBRARY_PATH=~/local/kicad/lib64
50+
```
51+
52+
# TODO list
53+
54+
There are some things that still need work:
55+
56+
* DRC checking - that can't be done over the Python interface yet.

0 commit comments

Comments
 (0)