aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Harder <radhermit@gmail.com>2015-11-25 23:08:45 -0500
committerTim Harder <radhermit@gmail.com>2015-11-25 23:09:27 -0500
commit0148c05f3c51ad034db18a91193daf6205dbb5f4 (patch)
tree6967fb3998ec761a27160da8ad29b71ff5529b11 /README.rst
parentpkgcheck: match the default colored output when listing checks (diff)
downloadpkgcheck-0148c05f3c51ad034db18a91193daf6205dbb5f4.tar.gz
pkgcheck-0148c05f3c51ad034db18a91193daf6205dbb5f4.tar.bz2
pkgcheck-0148c05f3c51ad034db18a91193daf6205dbb5f4.zip
doc: update installation notes
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 3d62f887..6651c55f 100644
--- a/README.rst
+++ b/README.rst
@@ -14,13 +14,25 @@ The metadata.xml checks require either xmllint (installed as part of
libxml2) or the python bindings to libxml2 (installed as part of
libxml2 with USE=python), with the latter preferred for speed reasons.
-Installation
-============
+Installing
+==========
No installation is strictly required: just run the ``pkgcheck`` script and
-as long as you are not root things should work. If you want to make
-pkgcheck available system-wide use the provided ``setup.py``
-(see `Installing python modules`_ for details).
+things should work. For a more permanent install see the following options:
+
+Installing latest pypi release in a virtualenv::
+
+ pip install pkgcheck
+
+Installing from git in a virtualenv (latest snakeoil/pkgcore are often required)::
+
+ pip install https://github.com/pkgcore/snakeoil/archive/master.tar.gz
+ pip install https://github.com/pkgcore/pkgcore/archive/master.tar.gz
+ pip install https://github.com/pkgcore/pkgcheck/archive/master.tar.gz
+
+Installing from a tarball or git repo::
+
+ python setup.py install pplugincache
Notes
=====