docs: add quickstart guide
Some checks failed
pcb-tools / test (3.5) (push) Has been cancelled
pcb-tools / test (3.6) (push) Has been cancelled
pcb-tools / test (3.7) (push) Has been cancelled
pcb-tools / test (3.8) (push) Has been cancelled
pcb-tools / coverage (push) Has been cancelled

This commit is contained in:
jaseg 2022-02-06 23:47:31 +01:00
parent e03e39b421
commit a939ab016e
2 changed files with 17 additions and 0 deletions

View file

@ -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