summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/about.rst38
-rw-r--r--doc/source/index.rst2
-rw-r--r--doc/source/intro.rst19
3 files changed, 39 insertions, 20 deletions
diff --git a/doc/source/about.rst b/doc/source/about.rst
new file mode 100644
index 0000000..1bb354c
--- /dev/null
+++ b/doc/source/about.rst
@@ -0,0 +1,38 @@
+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. 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.
+
+Visualization
+~~~~~~~~~~~~~~
+.. image:: ../../examples/composite_top.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.
+
+
+Future Plans
+~~~~~~~~~~~~
+We are working on adding the following features to PCB Tools:
+
+- Design Rules Checking
+- Editing
+- Panelization
+
+
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 309cf88..ab29738 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -11,7 +11,7 @@ Contents:
.. toctree::
:maxdepth: 1
- intro
+ about
documentation/index
Indices and tables
diff --git a/doc/source/intro.rst b/doc/source/intro.rst
deleted file mode 100644
index 4db80ad..0000000
--- a/doc/source/intro.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-PCB Tools Intro
-==================
-
-PCB CAM (Gerber) Files
-------------
-
-PCB design files (artwork) 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.
-
-
-PCB-Tools
-------------
-
-The gerber-tools module provides tools for working with and rendering Gerber
-and Excellon files.
-
-