summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2015-04-10 21:49:01 +0000
committerRalph Amissah <ralph@amissah.com>2015-04-13 20:39:36 +0000
commit094979631dddcfbd64d8f7aa6d3dfb3561e5992e (patch)
treeed82629002968ba97b4137cf4ca207737dca09c8 /README
parentinstall related, qi (quick install) & rake (diff)
downloadsisu-094979631dddcfbd64d8f7aa6d3dfb3561e5992e.zip
sisu-094979631dddcfbd64d8f7aa6d3dfb3561e5992e.tar.xz
documentation, acquiring source & installation, minor
Diffstat (limited to 'README')
-rw-r--r--README71
1 files changed, 59 insertions, 12 deletions
diff --git a/README b/README
index 7af7f69..ad3434e 100644
--- a/README
+++ b/README
@@ -37,15 +37,20 @@ Homepages:
INSTALL OR RUN WITHOUT INSTALLATION
***********************************
-SOURCE TARBALL
---------------
+SOURCE TREE
+-----------
RUN OFF SOURCE PACKAGE DIRECTORY TREE (WITHOUT INSTALLING)
..........................................................
-1. Download the latest source
+Download & unpack the latest source tarball
-2. Unpack the source
+or
+
+Git clone the latest source, to clone the latest source without the repo
+history:
+
+git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream
Provided you have *Ruby*, *SiSU* can be run without installation straight from
the source package directory tree. Run ruby against the full path to bin/sisu
@@ -55,14 +60,36 @@ Note however, that additional external package dependencies, such as texlive
(for pdfs), sqlite3 or postgresql (for search) should you desire to use them
are not taken care of for you.
-GEM INSTALL (WITH RAKE)
-.......................
+GEM INSTALL
+...........
Gem install, you need to:
(i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install
the gem
+
+----------------------------------------
+
+GEM INSTALL WITH QI (QUICK INSTALL) SCRIPT
+..........................................
+
+(This requires that ruby -thor is installed).
+
+qi (quick install) can go through the steps required to install the gem:
+
+ qi gem --create --build --install --stable
+
+or
+
+ qi gem --create --build --install --unstable
+
+
+----------------------------------------
+
+GEM INSTALL WITH RAKE
+.....................
+
Provided you have ruby & rake, this can be done with the single command:
rake gem_create_build_install # (to build and install sisu v5 & sisu v6,
@@ -79,7 +106,21 @@ separate gems are made/installed for sisu v5 & sisu v6 contained in source:
for individual steps (create, build, install) see rake options, rake -T to
specify sisu version for sisu installed via gem
- gem search sisu
+For a list of alternative actions you may type:
+
+ rake help
+
+ rake -T
+
+Rake: <http://rake.rubyforge.org/> <http://rubyforge.org/frs/?group_id=50>
+
+
+----------------------------------------
+
+MISC GEM
+........
+
+gem search sisu
sisu _5.6.2_ --version
@@ -89,15 +130,21 @@ to uninstall sisu installed via gem
sudo gem uninstall --verbose sisu
-For a list of alternative actions you may type:
+DIRECT INSTALLATION WITH QI (QUICK INSTALL) SCRIPT
+..................................................
- rake help
+(This requires that ruby -thor is installed).
- rake -T
+Root will be requested as required:
-Rake: <http://rake.rubyforge.org/> <http://rubyforge.org/frs/?group_id=50>
+ qi setup --bin --lib --conf --data --share --man
+
+or
+
+ qi setup --all
-Rant: <http://make.rubyforge.org/> <http://rubyforge.org/frs/?group_id=615>
+You may wish to do a dryrun to see where files would be installed without
+copying them, to do so add the flag --dryrun
INSTALLATION WITH SETUP.RB
..........................