README

   1 Gerbv -- a Gerber file viewer
   2
   3 Gerbv is part of the gEDA Project
   4 ------------------------------------------------------------------------------
   5
   6 -- About gerbv
   7
   8   *  Gerbv is a viewer for Gerber RS-274X files, Excellon drill files, and CSV
   9      pick-and-place files.  (Note:  RS-274D files are not supported.)
  10   *  Gerbv is a native Linux application, and it runs on many common unix
  11      platforms.
  12   *  Gerbv is free/ open-source software.
  13   *  The core functionality of gerbv is located in a separate library
  14      (libgerbv), allowing developers to include Gerber
  15      parsing/editing/exporting/rendering into other programs.
  16   *  Gerbv is one of the utilities affiliated with the gEDA project, an
  17      umbrella organization dedicated to producing free software tools for
  18      electronic design.
  19
  20 -- Building gerbv by downloading a release tarball
  21
  22    1. Download source tarballs from http://gerbv.sourceforge.net.
  23    2. Expand source by running gzip -dc <filename> | tar xf -
  24    3. Change to newly expanded directory
  25    4. Type ./configure <switches>.
  26       The following (gerbv) switches are available to configure:
  27           * --help: Lists all configure options.
  28           * --enable-debug: Program will output lots of debug
  29               spew while running. (default = no -> no debug output
  30               by default.)
  31           * --disable-exportpng: Disable compilation of export
  32               of PNGs. (default = no -> exportpng on by default.)
  33           * --enable-unit-mm: Set default unit for coordinates in
  34               status bar to mm (default = no -> units = inches
  35               by default.)
  36           * --disable-cairo: Use GDK only for graphics rendering.
  37               (default = no -> both GDK and cairo used by default.)
  38           * --enable-efence: Link with ElectricFence for malloc
  39               debugging (default = no -> efence off by default.)
  40           * --disable-update-desktop-database: Update desktop icon
  41               database after installation (default = no -> desktop
  42               icon installed by default.)
  43    5. Type make
  44    6. Type make install. Please note that if you want to install
  45       it in a system directory you have to su first.
  46    7. Test by typing gerbv
  47
  48 -- Building gerbv by downloading from anonymous CVS
  49
  50    1. Login to anonymous CVS (only needed the first time):
  51       cvs -d:pserver:anonymous@gerbv.cvs.sourceforge.net:/cvsroot/gerbv login .
  52       Press Enter when CVS asks for a password.
  53    2. Check out the source tree:
  54       cvs -z3 -d:pserver:anonymous@gerbv.cvs.sourceforge.net:/cvsroot/gerbv co gerbv
  55    3. Recreate all build system files:
  56       sh autogen.sh
  57    4. Type ./configure <switches>.
  58       The following (gerbv) switches are available to configure:
  59           * --help: Lists all configure options.
  60           * --enable-debug: Program will output lots of debug
  61               spew while running. (default = no -> no debug output
  62               by default.)
  63           * --disable-exportpng: Disable compilation of export
  64               of PNGs. (default = no -> exportpng on by default.)
  65           * --enable-unit-mm: Set default unit for coordinates in
  66               status bar to mm (default = no -> units = inches
  67               by default.)
  68           * --disable-cairo: Use GDK only for graphics rendering.
  69               (default = no -> both GDK and cairo used by default.)
  70           * --enable-efence: Link with ElectricFence for malloc
  71               debugging (default = no -> efence off by default.)
  72           * --disable-update-desktop-database: Update desktop icon
  73               database after installation (default = no -> desktop
  74               icon installed by default.)
  75    5. Type make
  76    6. Type make install. Please note that if you want to install
  77       it in a system directory you have to su first.
  78    7. Test by typing gerbv
  79    8. Run cvs update in the checked out gerbv directory to get
  80       the latest changes.
  81
  82 --  Supported platforms
  83 Gerbv has been built and tested on
  84
  85     * Linux (2.2/2.4/2.6)
  86     * NetBSD/i386 (1.4.1)
  87     * NetBSD/Alpha (1.5.1)
  88     * Solaris (5.7 and 5.8)
  89
  90 -- Information for developers
  91
  92 Gerbv is split into a core functional library and a GUI portion. Developers
  93 wishing to incorporate Gerber parsing/editing/exporting/rendering into other
  94 programs are welcome to use libgerbv. Complete API documentation for libgerbv
  95 is here, as well as many example programs using libgerbv.
  96
  97 -- License
  98
  99   gerbv and all associated files is placed under the GNU Public
 100   License (GPL) version 2.0.  See the toplevel COPYING file for
 101   more information.
 102
 103   Programs and associated files are:
 104   Copyright 2001, 2002 by Stefan Petersen and the respective
 105   original authors (which are listed on the respective files)
 106
 107 -- Contact information
 108
 109 Bugs:  Please submit bug reports to the
 110 SourceForge bug tracker:
 111 http://sourceforge.net/tracker/?group_id=33921&atid=409538
 112
 113 Feature requests:  Please submit feature requests to the
 114 SourceForge feature request tracker:
 115 http://sourceforge.net/tracker/?group_id=33921&atid=409541
 116
 117 Patches:  Please submit patches to the
 118 SourceForge patch submission tracker:
 119 http://sourceforge.net/tracker/?group_id=33921&atid=409540
 120
 121 To communicate with a gerbv developer:  Please post your
 122 query on the geda-dev mailing list:
 123 http://www.seul.org/cgi-bin/mailman/listinfo/geda-dev