trunk/inst/doc/README

   1 To install:
   2
   3 $ cd ..
   4 $ R CMD INSTALL cran2deb
   5
   6 copy cran2deb/exec/cran2deb into somewhere in your executable path (e.g.,
   7 /usr/local/bin, $home/bin)
   8
   9
  10
  11 To configure:
  12
  13 1. You need a web server serving from say, /var/www/cran2deb/
  14
  15 Let ROOT be the value returned by running: cran2deb root
  16 Let SYS be the system you wish to build for (e.g., debian-amd64)
  17
  18 2. create /etc/cran2deb
  19    a. copy ROOT/etc/* into /etc/cran2deb/
  20    b. ensure ROOT/etc/sys/SYS is set up
  21    c. /etc/cran2deb/archive should be a symlink pointing to /var/www/cran2deb/
  22
  23     $ ln -s /var/www/cran2deb/ /etc/cran2deb/archive
  24     $ mkdir /var/www/cran2deb/SYS
  25
  26    d. modify OTHERMIRROR of /etc/cran2deb/sys/SYS/pbuilderrc.in to point to your webserver
  27    e. run: cran2deb repopulate
  28
  29 3. cran2deb needs a persistent cache outside of R's control. therefore, create
  30     /var/cache/cran2deb, writable by whichever user(s) will run cran2deb.
  31 4. run: cran2deb update
  32 5. Try building a simple package: cran2deb build zoo
  33    (The result will be in /var/cache/cran2deb/results/SYS)
  34
  35
  36 $ cran2deb help
  37 will display a short summary of help for each cran2deb command.
  38
  39
  40 Concerning data/:
  41 This contains scripts necessary to recreate the database should you loose the
  42 database. It's a backup that can be versioned by SVN. There is a script called
  43 pull that, when run from the data directory will recreate all the files from
  44 the database EXCEPT for the licenses. The licenses cannot be recreated because
  45 licenses can be based on one-way hashes.  This process could certainly be
  46 improved.
  47