Skip to content

Commit

Permalink
pykicad: Add project status to README.
Browse files Browse the repository at this point in the history
* README.md: Add status section.
  • Loading branch information
dvc94ch committed Jul 12, 2017
1 parent fac4f4e commit 80034f9
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ The aim of this project is to provide high quality and well tested
format support so that other projects can focus on the interesting
stuff.

## Status
Complete support for the kicad_pcb and kicad_mod formats. The schemas of the
classes should provide good documentation on the kicad file format. A summary
of all methods and fields can be found in the section API docs.

## Usage
```python
Expand Down Expand Up @@ -74,8 +78,7 @@ pcb.segments += [s1, s2]
pcb.vias += [v1]


with open('project.kicad_pcb', 'w+') as f:
f.write(str(pcb))
pcb.to_file('project')
```


Expand Down Expand Up @@ -138,6 +141,7 @@ with open('project.kicad_pcb', 'w+') as f:
* outline()
* module_by_reference(name)
* net_by_code(code)
* to_file(path)
* from_file(cls, path)
* Segment(start, end, net, width, layer, tstamp, status)
* Text(text, at, layer, size, thickness, bold, italic, justify, hide, tstamp)
Expand Down

0 comments on commit 80034f9

Please sign in to comment.