README

   1 =============================
   2 xgsch2pcb - a GUI for gsch2pcb
   3 ==============================
   4
   5
   6 Introduction
   7 ------------
   8
   9 When designing a printed circuit board (PCB) it's often desirable to
  10 create a 'schematic' which shows the components to be used and their
  11 connectivity in an abstract fashion.  The connectivity information is
  12 then used to help when designing the actual circuit board.
  13
  14 ``gsch2pcb`` is a command-line tool, part of the gEDA suite, which is used
  15 to generate and update a PCB layout.  It works with schematics created
  16 by ``gschem``, part of the gEDA suite, and layouts created by ``pcb``, a
  17 PCB layout system commonly used with gEDA.
  18
  19 ``xgsch2pcb`` provides an intuitive, user-friendly graphical interface to
  20 ``gsch2pcb``.
  21
  22
  23 Requirements
  24 ------------
  25
  26 ``xgsch2pcb`` requires:
  27
  28  * python >= 2.4
  29  * python-gtk2 >= 2.8
  30  * python-gobject (if using python-gtk2 >= 2.10)
  31  * python-dbus
  32  * A recent version of the gEDA suite
  33  * A version of ``pcb`` compiled with D-Bus support.
  34
  35 Optionally:
  36  * python-gnome2 (For launching the about URL)
  37
  38 Building ``xgsch2pcb`` from source code additionally requires:
  39
  40  * autoconf >= 2.59
  41  * automake
  42
  43
  44 Installation
  45 ------------
  46
  47 If you have fetched the sources from the git repository you will need to
  48 create the necessary autoconf files. To do this, change into the source
  49 directory and execute the command:
  50
  51   ./autogen.sh
  52
  53 This generates a ./configure script amongst other things, which you can run
  54 to configure the software.
  55
  56 As long as you have all the dependencies installed:
  57
  58   ./configure && make install
  59
  60
  61 Usage
  62 -----
  63
  64   xgsch2pcb [project]
  65
  66 The main window is divided into three main areas:
  67
  68 * The toolbar at the top offers the usual options to quit the
  69   program and to load and save project files.
  70
  71 * The left hand 'Schematic' frame shows a list of schematic pages that
  72   the PCB layout will be based on. The 'Edit schematic' and 'Edit
  73   attributes' buttons respectively launch ``gschem`` and ``gattrib`` to
  74   edit the selected schematic page.
  75
  76 * The right hand 'Layout' pane shows the name of the PCB layout file
  77   associated with the project. The 'Edit layout' button launches
  78   ``pcb`` to edit a file, and will offer to update your PCB layout if
  79   necessary.  The 'Update layout' button forces an update of the PCB
  80   layout even if one isn't strictly necessary.
  81
  82 The update process will carry out the following actions to modify your
  83 layout, after launching ``pcb`` if isn't already running:
  84
  85 1. Remove any elements from the layout that are not in the schematic.
  86
  87 2. Find any elements that are in the schematic but not in the layout,
  88    and add them to the layout (in the top left corner). N.b. that it's
  89    probably a good idea to leave this corner of your layout clear
  90    until the layout is more or less finalised, to avoid new elements
  91    interfering with elements which have already been placed and
  92    routed.
  93
  94 3. Clear your rats and load a new rats nest.
  95
  96 4. Update the component pin names to match the pin names on the
  97    schematic symbol.
  98
  99 Note that the update process won't modify your PCB file on disk, and
 100 will take into account any changes you have made since you last
 101 saved.
 102
 103 ..
 104    Local Variables:
 105    mode:rst
 106    End: