summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0e8009b..ef8fe50 100644
--- a/README.md
+++ b/README.md
@@ -5,4 +5,20 @@ gerber-tools
Tools to handle Gerber and Excellon files in Python.
+Example:
+
+ import gerber
+ from gerber.render import GerberSvgContext
+
+ # Read gerber and Excellon files
+ top_copper = gerber.read('example.GTL')
+ nc_drill = gerber.read('example.txt')
+
+ # Rendering context
+ ctx = GerberSvgContext
+
+ # Create SVG image
+ top_copper.render('top_copper.svg', ctx)
+ nc_drill.render('composite.svg', ctx)
+