README

   1 ==============================================
   2  'gschem and Friends' Electronic Design Suite
   3 ==============================================
   4
   5 Copyright (C) 1998-2009 gEDA Developers
   6
   7 Introduction
   8 ============
   9
  10 The GPL Electronic Design Automation (gEDA) project has produced and
  11 continues working on a full GPL'd suite and toolkit of Electronic
  12 Design Automation tools. These tools are used for electrical circuit
  13 design, schematic capture, simulation, prototyping, and
  14 production. Currently, the gEDA project offers a mature suite of free
  15 software applications for electronics design, including schematic
  16 capture, attribute management, bill of materials (BOM) generation,
  17 netlisting into over 20 netlist formats, analog and digital
  18 simulation, and printed circuit board (PCB) layout.
  19
  20 The gEDA project was started because of the lack of free EDA tools for
  21 POSIX systems with the primary purpose of advancing the state of free
  22 hardware or open source hardware. The suite is mainly being developed
  23 on the GNU/Linux platform with some development effort going into
  24 making sure the tools run on other platforms as well.
  25
  26 The gEDA/gaf suite (this package) provides schematic capture,
  27 netlisting, bill of materials generation, and many other features.
  28
  29 Installation
  30 ============
  31
  32 The information in this section is intended to supplement the
  33 information in the `INSTALL' file.
  34
  35 Dependencies
  36 ------------
  37
  38 In order to compile gEDA from the distributed source archives, you
  39 *must* have the following tools and libraries installed:
  40
  41  - A C compiler and standard library (GCC/glibc are recommended).
  42
  43  - The `pkg-config' tool for managing shared libraries.
  44    <http://pkgconfig.freedesktop.org/>
  45
  46  - Guile ("GNU's Ubiquitous Intelligent Language for Extensions"),
  47    version 1.8.0 or later.  <http://www.gnu.org/software/guile/>
  48
  49  - GTK+ (the Gimp Toolkit), version 2.10.0 or later.
  50    <http://www.gtk.org/>
  51
  52  - The `lex' tool for generating lexical scanners.  The `flex'
  53    implementation recommended.  <http://flex.sourceforge.net/>
  54
  55  - The `awk' tool for data processing.  GNU Awk (`gawk') is
  56    recommended.  <http://www.gnu.org/software/gawk/>
  57
  58 The following tools and libraries are *highly recommended*:
  59
  60  - GNU `gettext', version 0.16 or newer.
  61    <http://www.gnu.org/software/gettext/>
  62
  63  - GNU `troff' (`groff'). <http://www.gnu.org/software/groff/>
  64
  65  - The freedesktop.org MIME info database.
  66    <http://freedesktop.org/Software/shared-mime-info>
  67
  68  - The freedesktop.org utilities for manipulating .desktop files.
  69    <http://www.freedesktop.org/software/desktop-file-utils>
  70
  71 The following tools and libraries are optional:
  72
  73  - `libstroke', a stroke and gesture recognition library.  If this is
  74    available, gschem will support mouse gesture recognition.
  75    <http://www.etla.net/libstroke/>
  76
  77  - The `doxygen' API documentation tool.  This is required for
  78    building the gEDA developer API documentation, not for the regular
  79    user documentation.  <http://www.stack.nl/~dimitri/doxygen/>
  80
  81 Troubleshooting dependencies
  82 ----------------------------
  83
  84   "I've installed the `libfoo' library, but `./configure' isn't
  85   picking it up!"
  86
  87 Many modern operating system distributions split a library into two
  88 packages:
  89
  90 1. a `libfoo' package, which contains the files necessary to
  91    *run* programs which use `libfoo'.
  92
  93 2. a `libfoo-dev' or `libfoo-devel' package, which contains the files
  94    necessary to *compile* programs which use `libfoo'.
  95
  96 If you're having problems, make sure that you have all of the
  97 necessary `dev' or `devel' packages installed.
  98
  99 Installation from a source archive
 100 ----------------------------------
 101
 102 First extract the archive to a sensible place:
 103
 104   tar -xzvf gEDA-gaf-<version>.tar.gz && cd gEDA-gaf-<version>
 105
 106 Run the configuration script.  You'll probably want to specify a
 107 custom directory to install gEDA to, for example:
 108
 109   ./configure --prefix=$HOME/geda
 110
 111 You can then compile gEDA:
 112
 113   make
 114
 115 And install it (if you used a `--prefix' outside your $HOME directory,
 116 you may need to run this as root):
 117
 118   make install
 119
 120 For more information on installing gEDA, see the `INSTALL' document.
 121
 122 Installation from the git repository
 123 ------------------------------------
 124
 125 gEDA uses the `git' version control system.  If you wish to try out
 126 the very latest version of gEDA, you will need to install some extra
 127 tools *in addition to* the ones listed above:
 128
 129   - The `git' version control tool, version 1.6 or newer.
 130     <http://git-scm.com/>
 131
 132   - GNU Automake, version 1.6.0 or newer.
 133     <http://www.gnu.org/software/automake/>
 134
 135   - GNU Autoconf, version 2.60 or newer.
 136     <http://www.gnu.org/software/autoconf/>
 137
 138   - GNU Libtool.  <http://www.gnu.org/software/libtool/>
 139
 140 Once you have these installed, you need to clone the gEDA `git'
 141 repository:
 142
 143   git clone git://git.gpleda.org/gaf.git
 144
 145 To generate the configure script, run:
 146
 147   ./autogen.sh
 148
 149 You can then procede to configure and build gEDA as described above.
 150 For more information on working with the gEDA `git' repository, see
 151 <http://geda.seul.org/wiki/geda:scm>.
 152
 153 Tools in the gEDA suite
 154 =======================
 155
 156 The major components of the gEDA suite are:
 157
 158 `libgeda'
 159   A library of functions for manipulating gEDA schematics and symbols.
 160
 161 `gschem'
 162   A schematic editor.
 163
 164 `gattrib'
 165   A spreadsheet-like program for bulk editing of component attributes.
 166
 167 `gnetlist'
 168   A highly-flexible, hierarchy-aware utility which parses schematics
 169   to generate a number of outputs, including netlists for a wide
 170   variety of PCB layout tools.  It can also generate bills of
 171   materials and DRC reports for your schematics.
 172
 173 `gsch2pcb'
 174   A command-line utility for streamlining the workflow where `PCB'
 175   <http://pcb.gpleda.org/> and `gschem' are used together.
 176
 177 `gsymcheck'
 178   A utility for checking for common errors in schematic symbol files.
 179
 180 Getting help
 181 ============
 182
 183 There are several ways to get help with installing and using gEDA:
 184
 185  - The gEDA website <http://www.gpleda.org> has more extensive
 186    information on the gEDA tools, and links to some successful
 187    projects which use gEDA.
 188
 189  - The gEDA documentation wiki contains a large amount of helpful
 190    information.  A static copy is included with this distribution; see
 191    the `docs/wiki/index.html' file.  The wiki is accessible online at
 192    <http://geda.seul.org/wiki/>.
 193
 194  - If the resources above didn't help you resolve your problem, or you
 195    are having a *design* problem that you want to get help with,
 196    consider subscribing to and posting your question to the
 197    `geda-user' mailing list.
 198    <http://www.gpleda.org/mailinglists.html>
 199
 200  - If you have discovered a bug, have a feature request, or have
 201    written a patch to gEDA, please create an item on the gEDA issue
 202    tracker.  <http://sourceforge.net/tracker/?group_id=161080>
 203
 204 License
 205 =======
 206
 207 gEDA/gaf (this package) is freely distributable under the GNU Public
 208 License (GPL) version 2.0 or (at your option) any later version.  See
 209 the `COPYING' file for the full text of the license.
 210
 211 The programs and associated files are:
 212
 213   Copyright (C) 1998-2009 by Ales Hvezda and the respective original
 214   authors.
 215
 216 See the `AUTHORS' file for a more extensive list of contributors to
 217 gEDA.
 218
 219 ..
 220    Local Variables:
 221    mode: text
 222    End: