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           * --enable-unit-mm: Set default unit for coordinates in
  32               status bar to mm (default = no -> units = inches
  33               by default.)
  34           * --enable-efence: Link with ElectricFence for malloc
  35               debugging (default = no -> efence off by default.)
  36           * --disable-update-desktop-database: Update desktop icon
  37               database after installation (default = no -> desktop
  38               icon installed by default.)
  39    5. Type make
  40    6. Type make install. Please note that if you want to install
  41       it in a system directory you have to su first.
  42    7. Test by typing gerbv
  43
  44 -- Building gerbv by downloading from anonymous CVS
  45
  46    1. Login to anonymous CVS (only needed the first time):
  47       cvs -d:pserver:anonymous@gerbv.cvs.sourceforge.net:/cvsroot/gerbv login .
  48       Press Enter when CVS asks for a password.
  49    2. Check out the source tree:
  50       cvs -z3 -d:pserver:anonymous@gerbv.cvs.sourceforge.net:/cvsroot/gerbv co gerbv
  51    3. Recreate all build system files:
  52       sh autogen.sh
  53    4. Type ./configure <switches>.
  54       The following (gerbv) switches are available to configure:
  55           * --help: Lists all configure options.
  56           * --enable-debug: Program will output lots of debug
  57               spew while running. (default = no -> no debug output
  58               by default.)
  59           * --enable-unit-mm: Set default unit for coordinates in
  60               status bar to mm (default = no -> units = inches
  61               by default.)
  62           * --enable-efence: Link with ElectricFence for malloc
  63               debugging (default = no -> efence off by default.)
  64           * --disable-update-desktop-database: Update desktop icon
  65               database after installation (default = no -> desktop
  66               icon installed by default.)
  67    5. Type make
  68    6. Type make install. Please note that if you want to install
  69       it in a system directory you have to su first.
  70    7. Test by typing gerbv
  71    8. Run cvs update in the checked out gerbv directory to get
  72       the latest changes.
  73
  74 --  Supported platforms
  75 Gerbv has been built and tested on
  76
  77     * Linux (2.2/2.4/2.6)
  78     * NetBSD/i386 (1.4.1)
  79     * NetBSD/Alpha (1.5.1)
  80     * Solaris (5.7 and 5.8)
  81
  82 -- Information for developers
  83
  84 Gerbv is split into a core functional library and a GUI portion. Developers
  85 wishing to incorporate Gerber parsing/editing/exporting/rendering into other
  86 programs are welcome to use libgerbv. Complete API documentation for libgerbv
  87 is here, as well as many example programs using libgerbv.
  88
  89 -- License
  90
  91   gerbv and all associated files is placed under the GNU Public
  92   License (GPL) version 2.0.  See the toplevel COPYING file for
  93   more information.
  94
  95   Programs and associated files are:
  96   Copyright 2001, 2002 by Stefan Petersen and the respective
  97   original authors (which are listed on the respective files)
  98
  99 -- Contact information
 100
 101 Bugs:  Please submit bug reports to the
 102 SourceForge bug tracker:
 103 http://sourceforge.net/tracker/?group_id=33921&atid=409538
 104
 105 Feature requests:  Please submit feature requests to the
 106 SourceForge feature request tracker:
 107 http://sourceforge.net/tracker/?group_id=33921&atid=409541
 108
 109 Patches:  Please submit patches to the
 110 SourceForge patch submission tracker:
 111 http://sourceforge.net/tracker/?group_id=33921&atid=409540
 112
 113 To communicate with a gerbv developer:  Please post your
 114 query on the geda-dev mailing list:
 115 http://www.seul.org/cgi-bin/mailman/listinfo/geda-dev