summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHamilton Kibbe <hamilton.kibbe@gmail.com>2015-02-15 22:00:03 -0500
committerHamilton Kibbe <hamilton.kibbe@gmail.com>2015-02-15 22:00:03 -0500
commitbc532997aecc60f5a939f9ca6ba55dd3eae27a42 (patch)
treeeea878f6841ddb5720b03f1d844de96035ed5672 /doc
parentd63bf0d68ae100c0413c7619f96d5d1c65da6c4e (diff)
downloadgerbonara-bc532997aecc60f5a939f9ca6ba55dd3eae27a42.tar.gz
gerbonara-bc532997aecc60f5a939f9ca6ba55dd3eae27a42.tar.bz2
gerbonara-bc532997aecc60f5a939f9ca6ba55dd3eae27a42.zip
Add feature support table per #9
Diffstat (limited to 'doc')
-rw-r--r--doc/source/about.rst30
-rw-r--r--doc/source/features.rst14
-rw-r--r--doc/source/index.rst1
3 files changed, 31 insertions, 14 deletions
diff --git a/doc/source/about.rst b/doc/source/about.rst
index 1bb354c..85e7184 100644
--- a/doc/source/about.rst
+++ b/doc/source/about.rst
@@ -1,29 +1,31 @@
About PCB Tools
===============
-PCB CAM Files
-~~~~~~~~~~~~~
-PCB design (artwork) files are most often stored in `Gerber` files. This is
-a generic term that may refer to `RS-274X (Gerber) <http://en.wikipedia.org/wiki/Gerber_format>`_,
-`ODB++ <http://en.wikipedia.org/wiki/ODB%2B%2B>`_ , or `Excellon <http://en.wikipedia.org/wiki/Excellon_format>`_
-files. These file formats are used by the CNC equipment used to manufacutre PCBs.
+PCB Tools provides a set of utilities for visualizing and working with PCB
+design files in a variety of formats. The design files are generally referred
+to as Gerber files. This is a generic term that may refer to
+`RS-274X (Gerber) <http://en.wikipedia.org/wiki/Gerber_format>`_,
+`ODB++ <http://en.wikipedia.org/wiki/ODB%2B%2B>`_ ,
+or `Excellon <http://en.wikipedia.org/wiki/Excellon_format>`_ files. These
+file formats are used by the CNC equipment used to manufacutre PCBs.
-PCB Tools provides a set of utilities for visualizing and working with PCB design files
-in a variety of formats. PCB Tools currently supports the following file formats:
+PCB Tools currently supports the following file formats:
- Gerber (RS-274X)
- Excellon
-with planned support for IPC-2581, IPC-D-356 Netlists, ODB++ and more.
+with planned support for IPC-2581, ODB++ and more.
-Visualization
-~~~~~~~~~~~~~~
-.. image:: ../../examples/composite_top.png
+Image Rendering
+~~~~~~~~~~~~~~~
+.. image:: ../../examples/cairo_example.png
:alt: Rendering Example
-The PCB Tools module provides tools to visualize PCBs and export images in a variety of formats,
-including SVG and PNG.
+The PCB Tools module provides tools to visualize PCBs and export images in a
+variety of formats, including SVG and PNG.
+
+
Future Plans
diff --git a/doc/source/features.rst b/doc/source/features.rst
new file mode 100644
index 0000000..120fdcd
--- /dev/null
+++ b/doc/source/features.rst
@@ -0,0 +1,14 @@
+Feature Suppport
+================
+
+Currently supported features are as follows:
+
+============ ======== =========== ================ ====== ======= =======
+File Format Parsing Rendering Unit Conversion Scale Offset Rotate
+============ ======== =========== ================ ====== ======= =======
+RS274-X Yes Yes Yes No No No
+Excellon Yes Yes Yes No No No
+ODB++ No No No No No No
+============ ======== =========== ================ ====== ======= =======
+
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ab29738..c96ff8a 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -12,6 +12,7 @@ Contents:
:maxdepth: 1
about
+ features
documentation/index
Indices and tables