Merge pull request #3 from garretfick/merge-curtacircuitos

Merge curtacircuitos

1 files changed, 28 insertions, 8 deletions

diff --git a/README.md b/README.md
index 2695cca..27764be 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,22 @@
-gerber-tools

+pcb-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)](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.

 

 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)

@@ -25,7 +26,26 @@ Useage Example:
 Rendering Examples:

 -------------------

 ###Top Composite rendering

-![Composite Top Image](examples/composite_top.png)

+![Composite Top Image](examples/cairo_example.png)

 

-###Bottom Composite rendering

-![Composite Bottom Image](examples/composite_bottom.png)
\ No newline at end of file
+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