gsoc_final

[cran2deb.git] / tags / gsoc_final / inst / doc / README

diff --git a/tags/gsoc_final/inst/doc/README b/tags/gsoc_final/inst/doc/README
new file mode 100644 (file)
index 0000000..038e70a
--- /dev/null
+++ b/tags/gsoc_final/inst/doc/README
@@ -0,0 +1,47 @@
+To install:
+
+$ cd ..
+$ R CMD INSTALL cran2deb
+
+copy cran2deb/exec/cran2deb into somewhere in your executable path (e.g.,
+/usr/local/bin, $home/bin)
+
+
+
+To configure:
+
+1. You need a web server serving from say, /var/www/cran2deb/
+
+Let ROOT be the value returned by running: cran2deb root
+
+2. ROOT/var/archive should be a symlink pointing to /var/www/cran2deb/
+    $ rm ROOT/var/archive
+    $ ln -s /var/www/cran2deb/ ROOT/var/archive
+3. modify OTHERMIRROR of ROOT/etc/pbuilderrc.in to point to your webserver
+4. cran2deb needs a persistent cache outside of R's control. therefore, create
+    /var/cache/cran2deb, writable by whichever user(s) will run cran2deb.
+5. run: cran2deb update
+6. Try building a simple package: cran2deb build zoo
+   (The result will be in /var/cache/cran2deb/results)
+
+
+
+Useful commands:
+cran2deb build <foo>
+
+cran2deb autobuild
+ - tries to build everything in the database that is out of date or failed on last build.
+
+cran2deb license
+ - license console for adding new licenses. see ROOT/data/populate_licenses for examples
+
+cran2deb depend
+ - dependency console for adding more dependencies, forced dependencies, system requirement patterns, and aliases.
+    see ROOT/data/populate_depend_aliases
+                  populate_forcedep
+                  populate_sysreq
+
+cran2deb update
+ - update the various caches and databases from the latest cran2deb static data, CRAN/BioC repos, and Debian
+ repos (for the pbuilder chroot)
+