From 39e2eda95db2a8b9608c7deb8f5f8e722ffaf300 Mon Sep 17 00:00:00 2001 From: jaseg Date: Sun, 6 Feb 2022 23:57:25 +0100 Subject: Update readme with doc link --- README.md | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e8681f6..d681aa3 100644 --- a/README.md +++ b/README.md @@ -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 --- -- cgit