From e53c6bba9bbdc265ca96396f979f0ad70598fa1c Mon Sep 17 00:00:00 2001 From: Paulo Henrique Silva Date: Tue, 17 Dec 2013 12:01:34 -0800 Subject: Initial commit --- README.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..31ca1d7 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +gerber-tools +============ -- cgit From c1518b5dfe7c5265ffa2df60598a0db223263ecb Mon Sep 17 00:00:00 2001 From: Paulo Henrique Silva Date: Tue, 17 Dec 2013 18:05:30 -0200 Subject: Working version of Gerber RS-274X parser. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 31ca1d7..d929f94 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ 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. + -- cgit 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 From fdbdbf24a6b706b04b6cbe97c0d74df6f0b57022 Mon Sep 17 00:00:00 2001 From: Paulo Henrique Silva Date: Tue, 28 Oct 2014 11:55:02 -0200 Subject: Change coveralls and travis badges --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2695cca..07d19d4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ 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) +![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master) +[![Coverage Status](https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master)](https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master) Tools to handle Gerber and Excellon files in Python. @@ -28,4 +28,4 @@ Rendering Examples: ![Composite Top Image](examples/composite_top.png) ###Bottom Composite rendering -![Composite Bottom Image](examples/composite_bottom.png) \ No newline at end of file +![Composite Bottom Image](examples/composite_bottom.png) -- cgit From af1e6b11d1092e459e7beaea5796736e91c2124a Mon Sep 17 00:00:00 2001 From: Paulo Henrique Silva Date: Tue, 28 Oct 2014 11:55:34 -0200 Subject: Renamed project --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 07d19d4..a2e3118 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -gerber-tools +pcb-tools ============ ![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master)](https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master) -- cgit From bfe14841604b6be403e7123e8b6667b1f0aff6f6 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sun, 15 Feb 2015 03:29:47 -0500 Subject: Add cairo example code, and use example-generated image in readme --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a2e3118..329d234 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ pcb-tools ============ -![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master) +[![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master)](https://travis-ci.org/curtacircuitos/pcb-tools) [![Coverage Status](https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master)](https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master) Tools to handle Gerber and Excellon files in Python. @@ -25,7 +25,5 @@ Useage Example: Rendering Examples: ------------------- ###Top Composite rendering -![Composite Top Image](examples/composite_top.png) - -###Bottom Composite rendering -![Composite Bottom Image](examples/composite_bottom.png) +![Composite Top Image](examples/cairo_example.png) +Source code for this example can be found [here](examples/cairo_example.py). -- cgit From 67f2af2015914da1cd8e06c254c8b6ff347fc9b2 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Wed, 18 Feb 2015 21:28:00 -0500 Subject: Add documentation link to README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 329d234..5453cf8 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ pcb-tools ============ [![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master)](https://travis-ci.org/curtacircuitos/pcb-tools) [![Coverage Status](https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master)](https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master) +[![Documentation Status](https://readthedocs.org/projects/pcb-tools/badge/?version=latest)](https://readthedocs.org/projects/pcb-tools/?badge=latest) Tools to handle Gerber and Excellon files in Python. @@ -27,3 +28,8 @@ Rendering Examples: ###Top Composite rendering ![Composite Top Image](examples/cairo_example.png) Source code for this example can be found [here](examples/cairo_example.py). + + +Documentation: +-------------- +[PCB Tools Documentation](http://pcb-tools.readthedocs.org/en/latest/) -- cgit From 7e2e469f5e705bcede137f15555da19898bf1f44 Mon Sep 17 00:00:00 2001 From: Paulo Henrique Silva Date: Sun, 15 Nov 2015 22:31:36 -0200 Subject: Remove svgwrite backend We moved the functionality to cairo backend, it can write png and svg and maybe more (pdfs?) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5453cf8..098b704 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,14 @@ Tools to handle Gerber and Excellon files in Python. Useage Example: --------------- import gerber - from gerber.render import GerberSvgContext + from gerber.render import GerberCairoContext # Read gerber and Excellon files top_copper = gerber.read('example.GTL') nc_drill = gerber.read('example.txt') # Rendering context - ctx = GerberSvgContext() + ctx = GerberCairoContext() # Create SVG image top_copper.render(ctx) -- cgit From a0847ef70d85ccc62022bc22eaeca4f94f7247d2 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sat, 19 Dec 2015 21:56:01 -0500 Subject: Update Readme --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 098b704..298cf0c 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Rendering Examples: ------------------- ###Top Composite rendering ![Composite Top Image](examples/cairo_example.png) + Source code for this example can be found [here](examples/cairo_example.py). -- cgit From 5df38c014fd09792995b2b12b1982c535c962c9a Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Thu, 28 Jan 2016 12:19:03 -0500 Subject: Cleanup, rendering fixes. fixed rendering of tented vias fixed rendering of semi-transparent layers fixed file type detection issues added some examples --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 298cf0c..cb73b30 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ pcb-tools Tools to handle Gerber and Excellon files in Python. -Useage Example: +Usage Example: --------------- import gerber from gerber.render import GerberCairoContext @@ -27,6 +27,7 @@ Rendering Examples: ------------------- ###Top Composite rendering ![Composite Top Image](examples/cairo_example.png) +![Composite Bottom Image](examples/cairo_bottom.png) Source code for this example can be found [here](examples/cairo_example.py). -- cgit From 7c7a2e03d99714ce9e5fd6fa35b5577cdac1e67b Mon Sep 17 00:00:00 2001 From: Ben FrantzDale Date: Tue, 22 Mar 2016 08:13:30 -0400 Subject: Add install instructions. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index cb73b30..0d93550 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,14 @@ Rendering Examples: Source code for this example can be found [here](examples/cairo_example.py). +Install from source: +``` +$ git clone https://github.com/curtacircuitos/pcb-tools.git +$ cd pcb-tools +$ make +$ python setup.py install +``` + Documentation: -------------- [PCB Tools Documentation](http://pcb-tools.readthedocs.org/en/latest/) -- cgit From 57c9dab99de34fd7ed77f75040d96ada25c41972 Mon Sep 17 00:00:00 2001 From: Ben FrantzDale Date: Tue, 22 Mar 2016 13:02:34 -0400 Subject: Remove "make" line. Apparently it's not necessary. --- README.md | 1 - 1 file changed, 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0d93550..5e46b02 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,6 @@ Install from source: ``` $ git clone https://github.com/curtacircuitos/pcb-tools.git $ cd pcb-tools -$ make $ python setup.py install ``` -- cgit From 52c6d4928a1b5fc65b95cf5b0784a560cec2ca1d Mon Sep 17 00:00:00 2001 From: Garret Fick Date: Sat, 16 Jul 2016 15:49:48 +0800 Subject: Fix most broken tests so that I can safely merge into changes with known expected test result --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 098b704..d33fa13 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,18 @@ Source code for this example can be found [here](examples/cairo_example.py). Documentation: -------------- [PCB Tools Documentation](http://pcb-tools.readthedocs.org/en/latest/) + + +Development and Testing: +------------------------ + +Dependencies for developing and testing pcb-tools are listed in test-requirements.txt. Use of a virtual environment is strongly recommended. + + $ virtualenv venv + $ source venv/bin/activate + (venv)$ pip install -r test-requirements.txt + (venv)$ pip install -e . + +We use nose to run pcb-tools's suite of unittests and doctests. + + (venv)$ nosetests -- cgit From 467bcdbc2a404b4b79adf6c092c8aed7eac8b9b5 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Tue, 29 Nov 2016 23:31:53 -0500 Subject: Update Installation Instructions --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index fae47e3..d7b359e 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ Install from source: ``` $ git clone https://github.com/curtacircuitos/pcb-tools.git $ cd pcb-tools +$ pip install -r requirements.txt $ python setup.py install ``` -- cgit From 6a77023bb017bf40ab6ee042b038b266f6fefccf Mon Sep 17 00:00:00 2001 From: Santiago Castro Date: Sun, 16 Apr 2017 16:46:15 -0300 Subject: Fix broken Markdown headings --- README.md | 120 +++++++++++++++++++++++++++++++------------------------------- 1 file changed, 60 insertions(+), 60 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d7b359e..f741f80 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,60 @@ -pcb-tools -============ -[![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master)](https://travis-ci.org/curtacircuitos/pcb-tools) -[![Coverage Status](https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master)](https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master) -[![Documentation Status](https://readthedocs.org/projects/pcb-tools/badge/?version=latest)](https://readthedocs.org/projects/pcb-tools/?badge=latest) - -Tools to handle Gerber and Excellon files in Python. - -Usage Example: ---------------- - import gerber - from gerber.render import GerberCairoContext - - # Read gerber and Excellon files - top_copper = gerber.read('example.GTL') - nc_drill = gerber.read('example.txt') - - # Rendering context - ctx = GerberCairoContext() - - # Create SVG image - top_copper.render(ctx) - nc_drill.render(ctx, 'composite.svg') - - -Rendering Examples: -------------------- -###Top Composite rendering -![Composite Top Image](examples/cairo_example.png) -![Composite Bottom Image](examples/cairo_bottom.png) - -Source code for this example can be found [here](examples/cairo_example.py). - - -Install from source: -``` -$ git clone https://github.com/curtacircuitos/pcb-tools.git -$ cd pcb-tools -$ pip install -r requirements.txt -$ python setup.py install -``` - -Documentation: --------------- -[PCB Tools Documentation](http://pcb-tools.readthedocs.org/en/latest/) - - -Development and Testing: ------------------------- - -Dependencies for developing and testing pcb-tools are listed in test-requirements.txt. Use of a virtual environment is strongly recommended. - - $ virtualenv venv - $ source venv/bin/activate - (venv)$ pip install -r test-requirements.txt - (venv)$ pip install -e . - -We use nose to run pcb-tools's suite of unittests and doctests. - - (venv)$ nosetests +pcb-tools +============ +[![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master)](https://travis-ci.org/curtacircuitos/pcb-tools) +[![Coverage Status](https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master)](https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master) +[![Documentation Status](https://readthedocs.org/projects/pcb-tools/badge/?version=latest)](https://readthedocs.org/projects/pcb-tools/?badge=latest) + +Tools to handle Gerber and Excellon files in Python. + +Usage Example: +--------------- + import gerber + from gerber.render import GerberCairoContext + + # Read gerber and Excellon files + top_copper = gerber.read('example.GTL') + nc_drill = gerber.read('example.txt') + + # Rendering context + ctx = GerberCairoContext() + + # Create SVG image + top_copper.render(ctx) + nc_drill.render(ctx, 'composite.svg') + + +Rendering Examples: +------------------- +### Top Composite rendering +![Composite Top Image](examples/cairo_example.png) +![Composite Bottom Image](examples/cairo_bottom.png) + +Source code for this example can be found [here](examples/cairo_example.py). + + +Install from source: +``` +$ git clone https://github.com/curtacircuitos/pcb-tools.git +$ cd pcb-tools +$ pip install -r requirements.txt +$ python setup.py install +``` + +Documentation: +-------------- +[PCB Tools Documentation](http://pcb-tools.readthedocs.org/en/latest/) + + +Development and Testing: +------------------------ + +Dependencies for developing and testing pcb-tools are listed in test-requirements.txt. Use of a virtual environment is strongly recommended. + + $ virtualenv venv + $ source venv/bin/activate + (venv)$ pip install -r test-requirements.txt + (venv)$ pip install -e . + +We use nose to run pcb-tools's suite of unittests and doctests. + + (venv)$ nosetests -- cgit From e5094c04a785e10aefc306d86755fcc57f39fc34 Mon Sep 17 00:00:00 2001 From: Paulo Henrique Silva Date: Mon, 25 Nov 2019 15:34:10 -0300 Subject: Rename requirements for docs and dev and upgrade nose and coverage packages --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f741f80..42c90f4 100644 --- a/README.md +++ b/README.md @@ -48,11 +48,11 @@ Documentation: Development and Testing: ------------------------ -Dependencies for developing and testing pcb-tools are listed in test-requirements.txt. Use of a virtual environment is strongly recommended. +Dependencies for developing and testing pcb-tools are listed in requirements-dev.txt. Use of a virtual environment is strongly recommended. $ virtualenv venv $ source venv/bin/activate - (venv)$ pip install -r test-requirements.txt + (venv)$ pip install -r requirements-dev.txt (venv)$ pip install -e . We use nose to run pcb-tools's suite of unittests and doctests. -- cgit From ef589a064015de3a1ce6487dbb56b99332673e9d Mon Sep 17 00:00:00 2001 From: Paulo Henrique Silva Date: Tue, 26 Nov 2019 00:37:41 -0300 Subject: Migrate to pytest (#111) * Migrate to pytest All tests were update to use pytest. Tests were alse black formatted. Eventually all code will be black formatted but need to merge some PRs first. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 42c90f4..63fa47e 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,6 @@ Dependencies for developing and testing pcb-tools are listed in requirements-dev (venv)$ pip install -r requirements-dev.txt (venv)$ pip install -e . -We use nose to run pcb-tools's suite of unittests and doctests. +We use [pytest](https://docs.pytest.org/en/latest/) to run pcb-tools's suite of unittests and doctests. - (venv)$ nosetests + (venv)$ pytest -- cgit From 0024c0b045a29621845f4f1b5ee1283e32e38887 Mon Sep 17 00:00:00 2001 From: Paulo Henrique Silva Date: Tue, 26 Nov 2019 23:42:35 -0300 Subject: Update badges for GH actions and codecov --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 63fa47e..922b583 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ pcb-tools ============ -[![Travis CI Build Status](https://travis-ci.org/curtacircuitos/pcb-tools.svg?branch=master)](https://travis-ci.org/curtacircuitos/pcb-tools) -[![Coverage Status](https://coveralls.io/repos/curtacircuitos/pcb-tools/badge.png?branch=master)](https://coveralls.io/r/curtacircuitos/pcb-tools?branch=master) -[![Documentation Status](https://readthedocs.org/projects/pcb-tools/badge/?version=latest)](https://readthedocs.org/projects/pcb-tools/?badge=latest) +[![CI](https://github.com/curtacircuitos/pcb-tools/workflows/pcb-tools/badge.svg)](https://github.com/curtacircuitos/pcb-tools/actions) +[![Coverage](https://codecov.io/gh/curtacircuitos/pcb-tools/branch/master/graph/badge.svg)](https://codecov.io/gh/curtacircuitos/pcb-tools) +[![Docs](https://readthedocs.org/projects/pcb-tools/badge/?version=latest)](https://readthedocs.org/projects/pcb-tools/?badge=latest) Tools to handle Gerber and Excellon files in Python. -- cgit From 6ca4d3d1328556b7ff1d994001451dd473b40ccb Mon Sep 17 00:00:00 2001 From: johnthagen Date: Sat, 28 Dec 2019 20:55:43 -0500 Subject: Syntax highlight example code in README --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 922b583..64d6e8d 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,22 @@ Tools to handle Gerber and Excellon files in Python. Usage Example: --------------- - import gerber - from gerber.render import GerberCairoContext - # Read gerber and Excellon files - top_copper = gerber.read('example.GTL') - nc_drill = gerber.read('example.txt') +```py +import gerber +from gerber.render import GerberCairoContext - # Rendering context - ctx = GerberCairoContext() +# Read gerber and Excellon files +top_copper = gerber.read('example.GTL') +nc_drill = gerber.read('example.txt') - # Create SVG image - top_copper.render(ctx) - nc_drill.render(ctx, 'composite.svg') +# Rendering context +ctx = GerberCairoContext() +# Create SVG image +top_copper.render(ctx) +nc_drill.render(ctx, 'composite.svg') +``` Rendering Examples: ------------------- -- cgit