summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 31 insertions, 9 deletions
diff --git a/README.md b/README.md
index d929f94..2695cca 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,31 @@
-gerber-tools
-============
-
-This hopefully will be a useful set of tools to handle Gerber files in Python.
-
-Right now we have a working parser and I am working on simple Gerber to SVG converter.
-
-See gerber.md for some random information regardind Gerber format.
-
+gerber-tools
+============
+![Travis CI Build Status](https://travis-ci.org/hamiltonkibbe/gerber-tools.svg?branch=master)
+[![Coverage Status](https://coveralls.io/repos/hamiltonkibbe/gerber-tools/badge.png?branch=master)](https://coveralls.io/r/hamiltonkibbe/gerber-tools?branch=master)
+
+Tools to handle Gerber and Excellon files in Python.
+
+Useage 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(ctx)
+ nc_drill.render(ctx, 'composite.svg')
+
+
+Rendering Examples:
+-------------------
+###Top Composite rendering
+![Composite Top Image](examples/composite_top.png)
+
+###Bottom Composite rendering
+![Composite Bottom Image](examples/composite_bottom.png) \ No newline at end of file