diff options
author | jaseg <git@jaseg.de> | 2022-02-06 23:57:25 +0100 |
---|---|---|
committer | jaseg <git@jaseg.de> | 2022-02-06 23:57:25 +0100 |
commit | 39e2eda95db2a8b9608c7deb8f5f8e722ffaf300 (patch) | |
tree | 8914306981e259720167cae090433afd2e918735 | |
parent | 14027c552d0ed7346a7e92a7ed154e088ef160d9 (diff) | |
download | gerbonara-39e2eda95db2a8b9608c7deb8f5f8e722ffaf300.tar.gz gerbonara-39e2eda95db2a8b9608c7deb8f5f8e722ffaf300.tar.bz2 gerbonara-39e2eda95db2a8b9608c7deb8f5f8e722ffaf300.zip |
Update readme with doc link
-rw-r--r-- | README.md | 22 |
1 files changed, 7 insertions, 15 deletions
@@ -23,28 +23,20 @@ yay -S python-gerbonara Python: ``` -pip install gerbonara +pip install --user gerbonara ``` -# Usage +# Documentation and Examples -Here's a simple example: +Documentation can be found at: -```python -import gerbonara -from gerbonara.render import GerberCairoContext +https://gerbolyze.gitlab.io/gerbonara -# Read gerber and Excellon files -top_copper = gerbonara.read('example.GTL') -nc_drill = gerbonara.read('example.txt') +# Issues -# Rendering context -ctx = GerberCairoContext() +Please file any bugs at our issue tracker: -# Create SVG image -top_copper.render(ctx) -nc_drill.render(ctx, 'composite.svg') -``` +https://gitlab.com/gerbolyze/gerbonara/-/issues --- |