From a016af0afba25213afa829f79f0e9352a1591ed9 Mon Sep 17 00:00:00 2001 From: Andy Grunwald Date: Sun, 11 Oct 2015 19:20:58 +0200 Subject: [PATCH] Add a chapter about Installation Closes #14 --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 2b1088f7c..60068e6ad 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,34 @@ General options: Run 'sortinghat --help' to get information about a specific command. ``` +Installation +------------- + +You can install sortinghat just by running setup.py script: + +``` +$ python setup.py install +``` + +This will install it in the python default directories in your system. + +If you don't install sortinghat with root privileges, or don't want to install it in the default directories, you can also use the source code directory, as cloned from the main git repo. It is enough to +configure your `$PATH` and `$PYTHONPATH` so that sortinghat, and the Python modules it needs, are found. + +Add to your `$PATH` the directory which contains the sortinghat executables: + +``` +$ export PATH=$PATH:sortinghatdir/bin +``` + +In `$PYHTONPATH`, you need to include sortinghat as well. If sortinghatdir is the path where sortinghat is installed: + +``` +$ export PYTHONPATH=$PYTHONPATH:sortinghatdir +``` + +You are ready to use sortinghat! + Configuration -------------