doc: add netlistsvg installation instructions

TEST=make doc
Issue #26

Author: amstan

CONTRIBUTING.md

@@ -1,10 +1,12 @@
 # Developing PCBDL
 
-This command will setup the development enviroment so it will be eaasy to make changes to PCBDL:
+This command will setup the development enviroment so it will be easy to make changes to PCBDL:
 ```bash
 sudo pip3 install -r requirements.txt
 ```
 
+You probably also want to [install netlistsvg](https://google.github.io/pcbdl/doc/_build/html/netlistsvg.html#installation).
+
 ## Tests
 
 To test pcbdl framework functionality (not the schematics themselves), one can run:

README.md

@@ -142,7 +142,9 @@ Here's an example of such a [html output for servo micro](https://google.github.
 
 ### Schematics / Graphical representation of the circuit
 
-In order for schematics to be more easily parsable, we want to graphically display them. The [netlistsvg](https://github.com/nturley/netlistsvg) project has been proven to be an excellent tool to solve the hard problems of this. See `pcbdl/netlistsvg.py` for the implementation.
+In order for schematics to be more easily parsable, we want to graphically display them.
+The [netlistsvg](https://github.com/nturley/netlistsvg) project has been proven to be an excellent tool to solve the hard problems of this. See `pcbdl/netlistsvg.py` for the implementation.
+To use the following commands you'll have to [install netlistsvg](https://google.github.io/pcbdl/doc/_build/html/netlistsvg.html#installation).
 
 1. Convert a pcbdl schematic back into a traditional schematic
     ```python

doc/index.rst

@@ -7,5 +7,7 @@ PCBDL Documentation
 
    readme
    contributing
+   netlistsvg
+
    api
    small_parts

doc/netlistsvg.rst

@@ -0,0 +1,48 @@
+NetlistSVG
+==========
+
+Introduction
+------------
+`netlistsvg <https://github.com/nturley/netlistsvg>`_ is used by pcbdl to render a graphical output of the schematics.
+
+It uses the "analog skin" to get something similar to what an engineer would draw for a board/pcb level design:
+
+.. figure:: https://raw.githubusercontent.com/nturley/netlistsvg/master/doc/and.svg?sanitize=true
+
+    Netlistsvg's Analog Example
+    (TODO: replace drawing with a compact pcbdl example)
+
+
+Installation
+------------
+
+netlistsvg is written in javascript, to run it one needs both nodejs or npm.
+For debian style systems the following should do:
+
+.. code-block:: bash
+
+    sudo apt install nodejs npm
+
+One should plan for a location to install netlisvg, I recomend next to the pcbdl folder.
+
+I recommend grabbing the https://github.com/amstan/netlistsvg/tree/for-pcbdl branch.
+It has a few tweaks that make netlistsvg outputs so much better, but the changes still need to be
+merged with the upstream project.
+
+.. code-block:: bash
+
+    git clone -b for-pcbdl https://github.com/amstan/netlistsvg.git
+
+Then it can be installed with npm:
+
+.. code-block:: bash
+
+    cd netlistsvg
+    npm install .
+
+Finally pcbdl neets to be told where netlistsvg is, this is done using an `env variable <https://en.wikipedia.org/wiki/Environment_variable>`_.
+The default is assumed to be `~/netlistsvg`. The following can be added to .bashrc or where the user normally stores env variables::
+
+    export NETLISTSVG_LOCATION=~/path/to/installed/netlistsvg
+
+It can be tested by running :code:`make gh-pages` in `pcbdl/`, a bunch of `.svg` files will be created in `examples/`.