README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

Automatically generated overlay of R packages (roverlay) -- README

= What is roverlay? =

roverlay is a program that generates a portage overlay for R packages.
It runs without any user interaction and uses config files to control the
overlay creation.


= Directory overview =

roverlay/ -- roverlay python modules
config/   -- config files
eclass/   -- eclass file(s)
misc/     -- miscellaneous files, e.g. a sed expression that makes roverlay.py
             'installed'
doc/      -- documentation root directory
doc/rst   -- roverlay documentation (in reStructuredText)
doc/html  -- html version of the latest 'stable' rst documentation
doc/pydoc -- code self-documentation in html, can be created with 'make pydoc'


= Usage instructions =

./roverlay.py [option(s)] [command(s)]

Please see ./roverlay.py --help for all options and/or doc/rst, doc/html for
the full usage documentation, including software/hardware requirements.


= Installation =

See doc/rst and/or doc/html for installation instructions.