summaryrefslogtreecommitdiff
path: root/doc/source/about.rst
diff options
context:
space:
mode:
authorjaseg <git@jaseg.de>2021-06-06 13:25:45 +0200
committerjaseg <git@jaseg.de>2021-06-06 13:25:45 +0200
commit5a5ba2b709f01b2100cd767a25a41737541ad53c (patch)
tree6362ca960945e08d4a77b7f059e971e6099217c9 /doc/source/about.rst
parent8bad573131e4c91782425d81a141dd656b622d7b (diff)
parent72257258edf16cbda691483ef1fa722192ac0d38 (diff)
downloadgerbonara-5a5ba2b709f01b2100cd767a25a41737541ad53c.tar.gz
gerbonara-5a5ba2b709f01b2100cd767a25a41737541ad53c.tar.bz2
gerbonara-5a5ba2b709f01b2100cd767a25a41737541ad53c.zip
Graft pcb-tools upstream onto gerbonara tree
Diffstat (limited to 'doc/source/about.rst')
-rw-r--r--doc/source/about.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/source/about.rst b/doc/source/about.rst
new file mode 100644
index 0000000..85e7184
--- /dev/null
+++ b/doc/source/about.rst
@@ -0,0 +1,40 @@
+About PCB Tools
+===============
+
+
+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 currently supports the following file formats:
+
+- Gerber (RS-274X)
+- Excellon
+
+with planned support for IPC-2581, ODB++ and more.
+
+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.
+
+
+
+
+Future Plans
+~~~~~~~~~~~~
+We are working on adding the following features to PCB Tools:
+
+- Design Rules Checking
+- Editing
+- Panelization
+
+
+