[amateur-radio-guide] Brief documentation for a number of circuit design apps
John J. McDonough
jjmcd at fedoraproject.org
Mon Nov 8 15:57:55 UTC 2010
commit 4cf85c5ddf9bb5effe320f5b98e6cb22dafa46da
Author: John J. McDonough <wb8rcr at arrl.net>
Date: Mon Nov 8 10:57:39 2010 -0500
Brief documentation for a number of circuit design apps
en-US/Revision_History.xml | 3 ++
en-US/circuit-geda.xml | 83 +++++++++++++++++++++++++++++++++++++-------
en-US/circuit-gerbv.xml | 37 ++++++++++++-------
en-US/circuit-pcb.xml | 43 +++++++++++++++--------
4 files changed, 124 insertions(+), 42 deletions(-)
---
diff --git a/en-US/Revision_History.xml b/en-US/Revision_History.xml
index 1bc2ac4..b823c12 100644
--- a/en-US/Revision_History.xml
+++ b/en-US/Revision_History.xml
@@ -21,6 +21,9 @@
<member>Documentation for xconvers</member>
<member>Documentation for xdx</member>
<member>Documentation for xastir</member>
+ <member>Documentation for gEDA</member>
+ <member>Documentation for gerbv</member>
+ <member>Documentation for pcb</member>
</simplelist>
</revdescription>
</revision>
diff --git a/en-US/circuit-geda.xml b/en-US/circuit-geda.xml
index d3c1d90..c3cec89 100644
--- a/en-US/circuit-geda.xml
+++ b/en-US/circuit-geda.xml
@@ -3,17 +3,74 @@
]>
<section id="circuit-geda">
- <title>geda</title>
- <para>
- <figure float="0"><title>geda - gschem</title>
- <mediaobject>
- <imageobject><imagedata scale="99" scalefit="1" fileref="images/circuit-geda/gEDA.png" format="PNG"/></imageobject>
- <textobject><para>
- Drawing a schematic with gEDA
- </para>
- </textobject>
- </mediaobject>
- </figure>
+ <title>gEDA</title>
+ <para>
+ gEDA is a collection of packages for schematic capture, netlist
+ generation, circuit cimulation and PCB layout. Included in the geda
+ suite are:
+ <simplelist>
+ <member>
+ <package>geda-docs</package> - Documentation and example files
+ </member>
+ <member>
+ <package>geda-gattrib</package> - gEDA attribute editor
+ </member>
+ <member>
+ <package>geda-gnetlist</package> - Generates a netlist from a gEDA
+ schematic
+ </member>
+ <member>
+ <package>geda-symbols</package> - A library of symbols for gEDA
+ </member>
+ <member>
+ <package>geda-gschem</package> - The gEDA schematic capture
+ application
+ </member>
+ <member>
+ <package>geda-gsymcheck</package> - A symbol checker for schematics
+ </member>
+ <member>
+ In addition to the <package>geda-utils</package> utilities package,
+ <package>geda-gaf</package> design automation package, and
+ <package>libgeda</package> the gEDA library.
+ </member>
+ </simplelist>
+ Closely tied into gEDA and mentioned elsewhere in this guide are:
+ <simplelist>
+ <member>
+ <package>pcb</package> - The printed circuit board layout application
+ </member>
+ <member>
+ <package>gerbv</package> - Gerber viewer
+ </member>
+ <member>
+ <package>gwave</package> - The waveform viewer
+ </member>
+ <member>
+ <package>ngspice</package> - The circuit simulator
+ </member>
+ <member>
+ <package>gspiceui</package> - A GUI interface for
+ <package>ngspice</package>
+ </member>
+ </simplelist>
+ </para>
- </para>
-</section>
+ <para>
+ <figure float="0"><title>geda - gschem</title>
+ <mediaobject>
+ <imageobject><imagedata scale="99" scalefit="1" fileref="images/circuit-geda/gEDA.png" format="PNG"/></imageobject>
+ <textobject><para>
+ Drawing a schematic with gEDA
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ <para>
+ Users wishing to take full advantage of gEDA should consider installing
+ the <package>Electronic Lab</package> group which includes all the above
+ components as well as the <package>electronics-menu</package> package and
+ a number of other useful applications.
+ </para>
+ </section>
diff --git a/en-US/circuit-gerbv.xml b/en-US/circuit-gerbv.xml
index 477104d..a84f47f 100644
--- a/en-US/circuit-gerbv.xml
+++ b/en-US/circuit-gerbv.xml
@@ -2,17 +2,26 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docarticle/xml/4.5/docarticlex.dtd" [
]>
-<section id="circuit-gerbv">
- <title>gerbv</title>
- <para>
- <figure float="0"><title>gerbv</title>
- <mediaobject>
- <imageobject><imagedata scale="99" scalefit="1" fileref="images/circuit-gerbv/gerbv.png" format="PNG"/></imageobject>
- <textobject><para>
- Viewing a PCB with gerbv
- </para>
- </textobject>
- </mediaobject>
- </figure>
- </para>
-</section>
+ <section id="circuit-gerbv">
+ <title>gerbv</title>
+ <para>
+ <package>grebv</package> is a viewer for Gerber files.
+ </para>
+ <para>
+ In addition to selectively viewing and coloring Gerber layers,
+ <package>gerbv</package> allows the user to export the image in a number
+ of image formats for publication, as well as RS-274X compliant Gerbers and
+ Excellon drill files.
+ </para>
+ <para>
+ <figure float="0"><title>gerbv</title>
+ <mediaobject>
+ <imageobject><imagedata scale="99" scalefit="1"
+ fileref="images/circuit-gerbv/gerbv.png" format="PNG"/></imageobject>
+ <textobject><para> Viewing a PCB with gerbv
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </section>
diff --git a/en-US/circuit-pcb.xml b/en-US/circuit-pcb.xml
index c9104fc..4408190 100644
--- a/en-US/circuit-pcb.xml
+++ b/en-US/circuit-pcb.xml
@@ -2,18 +2,31 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docarticle/xml/4.5/docarticlex.dtd" [
]>
-<section id="circuit-pcb">
- <title>pcb</title>
- <para>
- <figure float="0"><title>pcb</title>
- <mediaobject>
- <imageobject><imagedata scale="99" scalefit="1" fileref="images/circuit-pcb/PCB.png" format="PNG"/></imageobject>
- <textobject><para>
- Drawing a PCB with pcb
- </para>
- </textobject>
- </mediaobject>
- </figure>
-
- </para>
-</section>
+ <section id="circuit-pcb">
+ <title>pcb</title>
+ <para>
+ <package>pcb</package> allows for the capture of printed circuit board
+ layouts.
+ </para>
+ <para>
+ In addition to purely manual layout, <package>pcb</package> can
+ import netlists from gschem. A large number of footprints are available
+ or the user may develop his own.
+ </para>
+ <para>
+ <figure float="0"><title>pcb</title>
+ <mediaobject>
+ <imageobject><imagedata scale="99" scalefit="1" fileref="images/circuit-pcb/PCB.png" format="PNG"/></imageobject>
+ <textobject><para>
+ Drawing a PCB with pcb
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ <para>
+ The application can generate a bill of material and drill file, and in
+ addition to printing various layers can export in a number of popular
+ formats.
+ </para>
+ </section>
More information about the docs-commits
mailing list