Skip to content

Commit

Permalink
Document extra steps required for installing development version.
Browse files Browse the repository at this point in the history
Fixes issue 364.
  • Loading branch information
Nikratio committed Jan 22, 2013
1 parent d0493a0 commit a8e2e39
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.HG
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ version may not work with any other version of S3QL (including the forthcoming
release). s3qladm may not be able to upgrade file systems either to or from
this version. You have been warned.

Please refer to rst/installation.rst for compilation and installation
instructions.
19 changes: 19 additions & 0 deletions rst/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,22 @@ Now you have three options:
* You can install S3QL into `~/.local` by executing `python
setup.py install --user`. In this case you should make sure that
`~/.local/bin` is in your `$PATH` environment variable.


Development Version
===================

If you have checked out the unstable development version from the
Mercurial repository, a bit more effort is required. You need to also
have Cython_ (0.16 or newer) and Sphinx_ (1.1 or newer) installed, and
the necessary commands are::

python setup.py build_cython
python setup.py build_ext --inplace
python setup.py build_sphinx
python setup.py test
python setup.py install

.. _Cython: http://www.cython.org/
.. _Sphinx: http://sphinx.pocoo.org/

0 comments on commit a8e2e39

Please sign in to comment.