* assign all files to a module (doxygen documentation)
[geda-gerbv.git] / README-cvs.txt
blobabbbf048ceadc1a023030dc1db7ac8bc1e336b1c
1 # $Id$
4 This file describes how to build from CVS sources.  If you are building from a
5 released version or snapshot, please refer to the 'INSTALL' document instead.
6 Take the time to read this file, it's not that long and it addresses some 
7 questions which come up with some frequency.
9 -------------
10 Prerequisites
11 -------------
13 You will need the following tools to obtain and build a CVS version of gerbv:
15 To download and track sources you will need:
17 cvs
18 ssh
21 In addition you will need recent versions of:
23 autoconf  -- ftp://ftp.gnu.org/pub/gnu/autoconf/
24              Version 2.59 or newer.
26 automake  -- ftp://ftp.gnu.org/pub/gnu/automake/
27              The developers use the 1.9.* versions of automake.  Older versions
28              have not been as well tested (or tested at all).  Versions 1.7 and
29              older are too old and will not work.
31 libtool   -- ftp://ftp.gnu.org/pub/gnu/libtool/
32              Version 1.4 and newer should work although most development is done
33              with 1.5.x.
35 You can find the version of autoconf, automake, and makeinfo by running them with the 
36 --version flag.
38 These are in addition to the normal tools and libraries required to build a
39 release version of gerbv.
41 ---------
42 Check out
43 ---------
45 If you already have a checked out gerbv source tree, please proceed to the
46 'Updating' section.
48 To check out sources from the anonymous CVS server, run the following:
50         cvs -d:pserver:anonymous@gerbv.cvs.sourceforge.net:/cvsroot/gerbv login 
51         cvs -z3 -d:pserver:anonymous@gerbv.cvs.sourceforge.net:/cvsroot/gerbv co gerbv
53 ---------
54 Updating
55 ---------
57 To update an already checked out copy of the gerbv source tree, run these commands
58 from your top level gerbv directory:
60         cvs login 
61         cvs -z3 update -PdA
63 ----------------------------------
64 Bootstrapping with the auto* tools
65 ----------------------------------
66 To create the configure script and the Makefile.in's
67 you will need to run 
69 ./autogen.sh
71 from the top level pcb directory.  This will run the various auto* tools
72 which creates the configure script, the config.h.in file and the various
73 Makefile.in's.
75 If you plan on making changes to configure.ac or Makefile.am's
76 you may want to enable maintainer mode by passing the
78 --enable-maintainer mode flag to ./configure
80 At this point you can proceed to configure and build gerbv as outlined in
81 the INSTALL document.
83 -------------------
84 Building a Snapshot
85 -------------------
86 The file README-release.txt documents what is currently done to create a
87 release for gerbv.  Most of what is in there has to do with the
88 cvs repository and how we tag and branch the sources.  If you are interested
89 in building your own .tar.gz file from CVS sources, you can still use
90 the information in README-release.txt as a guide.