README.git

   1 =======================
   2  Building PCB from git
   3 =======================
   4
   5 This file describes how to build from git sources.  If you are
   6 building from a released version or snapshot, please refer to the
   7 'INSTALL' document instead.  Take the time to read this file, it's not
   8 that long and it addresses some questions which come up with some
   9 frequency.
  10
  11 -------------
  12 Prerequisites
  13 -------------
  14
  15 You will need the following tools to obtain and build a git version of
  16 PCB:
  17
  18 git       -- To download and track sources you will need the 'git'
  19              version control tool installed.
  20
  21 To compile you will need a C compiler (such as 'gcc'), a 'lex' (or
  22 'flex') and a 'yacc' (or 'bison') implementation.  If you do not have
  23 'lex' or 'yacc', try installing:
  24
  25 bison     -- ftp://ftp.gnu.org/pub/gnu/bison/
  26 flex      -- ftp://ftp.gnu.org/pub/non-gnu/flex/
  27
  28 In addition you will need recent versions of:
  29
  30 autoconf  -- ftp://ftp.gnu.org/pub/gnu/autoconf/
  31              Please note that version 2.13 is too old.  Current development
  32              is done with 2.59.
  33
  34 automake  -- ftp://ftp.gnu.org/pub/gnu/automake/
  35              The developers use the 1.9.* versions of automake.  Older
  36              versions have not been as well tested (or tested at all).
  37              Versions 1.7 and older are too old and will not work.
  38
  39 gettext   -- ftp://ftp.gnu.org/pub/gnu/gettext/
  40              You will need version 0.14.x, or 0.16.x or higher
  41
  42 intltool  -- https://edge.launchpad.net/intltool/+download
  43              You will need version 0.35.0 or higher
  44
  45 texinfo   -- ftp://ftp.gnu.org/pub/gnu/texinfo/
  46              You will need at least version 4.6 to be able to build
  47              the documentation.
  48
  49 perl      -- Version 5 or newer.  This is needed for building the
  50              documentation.
  51
  52 latex     -- This is needed for building the documentation.
  53
  54 You can find the version of autoconf, automake, and makeinfo by
  55 running them with the '--version' flag.
  56
  57 If you do not wish to build the documentation, use '--disable-doc'
  58 when you run configure.  When building from a release tarball, the
  59 documentation comes preformatted.
  60
  61 ------------------------
  62 Clone the PCB repository
  63 ------------------------
  64
  65 If you have previously cloned the PCB source tree, please proceed to
  66 the updating section.
  67
  68 To clone the PCB repository to your computer, run:
  69
  70   git clone git://git.geda-project.org/pcb.git
  71
  72 This will download the entire version control history for PCB to
  73 your computer, and will take some time.
  74
  75 --------
  76 Updating
  77 --------
  78
  79 To update your git repository with the latest changes, simply run:
  80
  81   git pull
  82
  83 ----------------------------------
  84 Bootstrapping with the auto* tools
  85 ----------------------------------
  86 To create the configure script and the Makefile.in's
  87 you will need to run:
  88
  89   ./autogen.sh
  90
  91 from the top level PCB directory.  This will run various programs
  92 from the GNU autotools to create the 'configure' script, the
  93 'config.h.in' file and the various 'Makefile.in's.
  94
  95 At this point you can proceed to configure and build PCB as outlined
  96 in the 'INSTALL' document.
  97
  98 -------------------
  99 Building a Snapshot
 100 -------------------
 101
 102 The file 'README.snapshots' documents what is currently done to create
 103 a snapshot release for PCB.  Most of what is in there has to do with
 104 the cvs repository and how we tag and branch the sources.  If you are
 105 interested in building your own .tar.gz file from git sources, you can
 106 still use the information in 'README.snapshots' as a guide.
 107
 108 ------------------
 109 Advanced git usage
 110 ------------------
 111
 112 If you wish to use git to track your own changes to PCB, use git to
 113 contribute patches back to the community, or gain 'push' permissions
 114 for the PCB git repository, please see the gEDA wiki for more
 115 information:
 116
 117   http://wiki.geda-project.org/geda:scm
 118
 119 ------------------------
 120 Using CVS instead of git
 121 ------------------------
 122
 123 It is still possible to use CVS to access the PCB sources.  You can
 124 checkout the latest version using the command:
 125
 126   cvs -z3 -d:pserver:anonymous@git.geda-project.org/home/git/pcb.git co master
 127
 128 And update them using:
 129
 130   cvs -z3 update -PdA
 131
 132 ..
 133         Local Variables:
 134         mode: rst
 135         End: