diff options
author | jaseg <git@jaseg.de> | 2022-02-06 23:47:31 +0100 |
---|---|---|
committer | jaseg <git@jaseg.de> | 2022-02-06 23:47:31 +0100 |
commit | a939ab016e3f07a40df804ef3217b58427d09949 (patch) | |
tree | 843d3ef9335db7a9f1e699be06ab893a9eda7789 /docs/index.rst | |
parent | e03e39b421b92bb02c4fbf63393eaf5081f31181 (diff) | |
download | gerbonara-0.9.10.tar.gz gerbonara-0.9.10.tar.bz2 gerbonara-0.9.10.zip |
docs: add quickstart guidev0.9.10
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 15 |
1 files changed, 15 insertions, 0 deletions
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 |