aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAndré Erdmann <dywi@mailerd.de>2012-08-01 23:08:54 +0200
committerAndré Erdmann <dywi@mailerd.de>2012-08-01 23:08:54 +0200
commit02ee937512a9261570b126ca283e4b87de0daa91 (patch)
tree9e31ff0f7af49ea5c56bec840bc898dbefb4931b /README
parentactually skip manifest creation with --no-manifest (diff)
downloadR_overlay-02ee937512a9261570b126ca283e4b87de0daa91.tar.gz
R_overlay-02ee937512a9261570b126ca283e4b87de0daa91.tar.bz2
R_overlay-02ee937512a9261570b126ca283e4b87de0daa91.zip
docs
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 16 insertions, 8 deletions
diff --git a/README b/README
index 3be012c..40c2201 100644
--- a/README
+++ b/README
@@ -2,15 +2,24 @@ R overlay -- README
== How to use ==
-There is currently no "R overlay" script, only modules that implement functionality.
+./roverlay.py [option(s)] [command(s)]
-=== Running tests ===
-# <TODO> write this section
+See man/roverlay.1 or ./roverlay.py --help for all options.
-Real tests are scheduled for July 10 - July 30.
+=== Running tests ===
-A main script is available. See man/roverlay.1 or ./roverlay.py --help for usage.
+Just run the main script, the '--repo-config' option can be used to use
+other repo config files (instead of the default one that downloads ~50GB of packages).
+The '--no-manifest' switch can be used to disable Manifest creation, which saves a
+considerable amount of time at the expense of an unusable overlay
+(but useful to analyze created metadata, ebuild and depres results).
+Test run example:
+<<
+#!/bin/sh
+./roverlay.py sync
+time ./main.py --nosync --stats -O /tmp/created_overlay --no-manifest
+>>
== Configuration ==
@@ -18,11 +27,10 @@ A main script is available. See man/roverlay.1 or ./roverlay.py --help for usage
see config/R-overlay.conf
* repo configuration (CRAN,...)
-see config/repo.list
+see man/roverlay-repo.5
* description field configuration
see config/description_fields.conf
* dependency rules configuration
-see config/simple-deprules.conf
-
+see man/roverlay-deprules.5