From 9a98c2df3552211bce4639f19f1b85499b3e714a Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Tue, 30 Sep 2014 17:28:22 -0400 Subject: doc update --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d929f94..21dd807 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ gerber-tools ============ +![Travis CI Build Status](https://travis-ci.org/hamiltonkibbe/gerber-tools.svg?branch=master) -This hopefully will be a useful set of tools to handle Gerber files in Python. +Tools to handle Gerber and Excellon 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. -- cgit From 88fb7f23110d2270c5c7f8a7b90cae32295da78e Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Tue, 30 Sep 2014 17:55:47 -0400 Subject: doc update --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 21dd807..0e8009b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -gerber-tools -============ -![Travis CI Build Status](https://travis-ci.org/hamiltonkibbe/gerber-tools.svg?branch=master) - -Tools to handle Gerber and Excellon files in Python. - - +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. + + -- cgit From 100ab899ed7a1a49c3401b87b7d6b0f53a043dbc Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Tue, 7 Oct 2014 23:02:53 -0400 Subject: Updated README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'README.md') 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) + -- cgit From 1653ae5cbe88757e453bccf499dc1b8ccb278e58 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Wed, 8 Oct 2014 09:27:52 -0400 Subject: Update readme and example --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ef8fe50..1821c0a 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,8 @@ Example: nc_drill = gerber.read('example.txt') # Rendering context - ctx = GerberSvgContext + ctx = GerberSvgContext() # Create SVG image - top_copper.render('top_copper.svg', ctx) - nc_drill.render('composite.svg', ctx) - - + top_copper.render(ctx) + nc_drill.render(ctx, 'composite.svg') -- cgit From 62c689be172a7a06d76fd4b69c3443f3ec053765 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sat, 11 Oct 2014 13:12:21 -0400 Subject: Doc update --- README.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 1821c0a..ca30576 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,8 @@ Example: # Create SVG image top_copper.render(ctx) nc_drill.render(ctx, 'composite.svg') + + +Rendering: +![Composite Top Image](examples/composite_top.png) +![Composite Bottom Image](examples/composite_bottom.png) \ No newline at end of file -- cgit From d9018da412470053a063b7b28b5e32529fc573f6 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sat, 11 Oct 2014 13:14:47 -0400 Subject: Readme update --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ca30576..2695cca 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ gerber-tools Tools to handle Gerber and Excellon files in Python. -Example: - +Useage Example: +--------------- import gerber from gerber.render import GerberSvgContext @@ -22,6 +22,10 @@ Example: nc_drill.render(ctx, 'composite.svg') -Rendering: +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 -- cgit