Skip to content

Commit

Permalink
Add a chapter about Installation
Browse files Browse the repository at this point in the history
Closes chaoss#14
  • Loading branch information
andygrunwald authored and sduenas committed Oct 21, 2015
1 parent 0bb7670 commit a016af0
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,34 @@ General options:
Run 'sortinghat <command> --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
-------------

Expand Down

0 comments on commit a016af0

Please sign in to comment.