summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHamilton Kibbe <hamilton.kibbe@gmail.com>2014-10-07 23:02:53 -0400
committerHamilton Kibbe <hamilton.kibbe@gmail.com>2014-10-07 23:02:53 -0400
commit100ab899ed7a1a49c3401b87b7d6b0f53a043dbc (patch)
tree58c2dedd56bcbbc95de8f6c908e971acf82edc0c
parentaf97dcf2a8200d9319e20d2789dbb0baa0611ba5 (diff)
downloadgerbonara-100ab899ed7a1a49c3401b87b7d6b0f53a043dbc.tar.gz
gerbonara-100ab899ed7a1a49c3401b87b7d6b0f53a043dbc.tar.bz2
gerbonara-100ab899ed7a1a49c3401b87b7d6b0f53a043dbc.zip
Updated README
-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)
+