README.cvs

   1 # $Id$
   2 #
   3
   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.
   8
   9 -------------
  10 Prerequisites
  11 -------------
  12
  13 You will need the following tools to obtain and build a CVS version of pcb:
  14
  15 To download and track sources you will need:
  16
  17 cvs
  18 ssh
  19
  20 To compile you will need a C compiler, a lex (or flex) and a yacc (or bison)
  21 implementation.  If you do not have lex or yacc, try installing:
  22
  23 bison     -- ftp://ftp.gnu.org/pub/gnu/bison/
  24 flex      -- ftp://ftp.gnu.org/pub/non-gnu/flex/
  25
  26 In addition you will need recent versions of:
  27
  28 autoconf  -- ftp://ftp.gnu.org/pub/gnu/autoconf/
  29              Please note that version 2.13 is too old.  Current development
  30              is done with 2.59.
  31
  32 automake  -- ftp://ftp.gnu.org/pub/gnu/automake/
  33              The developers use the 1.9.* versions of automake.  Older versions
  34              have not been as well tested (or tested at all).  Versions 1.7 and
  35              older are too old and will not work.
  36
  37 texinfo   -- ftp://ftp.gnu.org/pub/gnu/texinfo/
  38              You will need at least version 4.6 to be able to build
  39              the documentation.
  40
  41 You can find the version of autoconf, automake, and makeinfo by running them with the
  42 --version flag.
  43
  44 If you do not wish to build the documentation, use --disable-doc when you run
  45 configure.  If you do wish to build the documentation, you should enable
  46 maintainer-mode (--enable-maintainer-mode) which will turn on various
  47 dependency rules for documentation building.  In addition you must build
  48 pcb with the png export HID enabled (it is enabled by default) because some
  49 of the figures in the manual are drawn with pcb.
  50
  51 Please note that maintainer-mode and the png HID are only needed when building
  52 documentation from cvs sources.  If you are building pcb from a distfile you
  53 do not need maintainer-mode and the png export HID is optional.
  54
  55 Finally, if you edit any of the actions identified by
  56 /* ACTION(Foo,ActionFoo) */
  57 comments, you will need perl and in addition, you must have used
  58 the --enable-maintainer-mode flag to the configure script.
  59
  60 ---------
  61 Check out
  62 ---------
  63
  64 If you already have a checked out PCB source tree, please proceed to the
  65 'Updating' section.
  66
  67 To check out sources from the anonymous CVS server, run the following:
  68
  69         cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/pcb login
  70         cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/pcb co pcb
  71
  72 ---------
  73 Updating
  74 ---------
  75
  76 To update an already checked out copy of the PCB source tree, run these commands
  77 from your top level pcb directory:
  78
  79         cvs login
  80         cvs -z3 update -PdA
  81
  82 ----------------------------------
  83 Bootstrapping with the auto* tools
  84 ----------------------------------
  85 To create the configure script and the Makefile.in's
  86 you will need to run
  87
  88 ./autogen.sh
  89
  90 from the top level pcb directory.  This will run the various auto* tools
  91 which creates the configure script, the config.h.in file and the various
  92 Makefile.in's.
  93
  94 If you plan on making changes to configure.ac, Makefile.am's, or actions
  95 defined by the
  96 /* ACTION(Foo,ActionFoo) */
  97 comments, you may want to enable maintainer mode by passing the
  98 --enable-maintainer mode flag to ./autogen.sh
  99
 100 At this point you can proceed to configure and build PCB as outlined in
 101 the INSTALL document.
 102
 103 -------------------
 104 Building a Snapshot
 105 -------------------
 106 The file README.snapshots documents what is currently done to create a
 107 snapshot release for PCB.  Most of what is in there has to do with the
 108 cvs repository and how we tag and branch the sources.  If you are interested
 109 in building your own .tar.gz file from CVS sources, you can still use
 110 the information in README.snapshots as a guide.
 111