diff --git a/docs/index.rst b/docs/index.rst index f3fb872..07bb084 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -57,6 +57,21 @@ Features Quick Start =========== +First, install gerbonara from PyPI using pip: + +.. highlight:: shell + + pip install --user gerbonara + +Then, you are ready to read and write gerber files: + +.. highlight:: python + + from gerbonara import LayerStack + + stack = LayerStack.from_directory('output/gerber') + w, h = stack.outline.size('mm') + print(f'Board size is {w:.1f} mm x {h:.1f} mm') Development diff --git a/gerbonara/NOTES b/gerbonara/NOTES index efaa511..49abb31 100644 --- a/gerbonara/NOTES +++ b/gerbonara/NOTES @@ -13,6 +13,7 @@ To do [X] Handle upverter output correctly: Upverter puts drils in a file called "design_export.xln" that actually contains Gerber, not Excellon [X] Add standard comment/attribute support for Gerber and Excellon +[ ] Add attribute support to gerber output [X] Add file/lineno info to all warnings and syntax errors [X] Make sure we handle arcs with co-inciding start/end points correctly (G74: no arc, G75: full circle) [ ] Add allegro drill test files with different zero suppression settings @@ -40,3 +41,4 @@ To do [ ] Add "number of parameters" property to ApertureMacro [ ] Aperture macro outline: Warn if first and last point are not the same. [ ] Make sure incremental mode actually works for gerber import +[ ] Add text rendering function