Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added docs section about running the program from source

  • Loading branch information...
commit d63b8c644cec91192bd4cc46ea9ba61cbfc75603 1 parent b33299d
@dvarrazzo authored
Showing with 24 additions and 3 deletions.
  1. +24 −3 docs/install.rst
View
27 docs/install.rst
@@ -38,10 +38,31 @@ to perform a local installation.
Installation from source
------------------------
-The program can be also installed from the source, either from the git
-repository or from a source package: in this case you can install the program
-using::
+The program can also be installed from the source, either from a `source
+package`__ or from the `source repository`__: in this case you can install the
+program using::
$ python setup.py install
+.. __: http://pypi.python.org/pypi/pgxnclient/
+.. __: https://github.com/dvarrazzo/pgxnclient/
+
+
+Running from the project directory
+----------------------------------
+
+You can also run PGXN Client directly from the project directory, either
+unpacked from a `source package`__, or cloned from the `source repository`__,
+without performing any installation.
+
+Just make sure that the project directory is in the :envvar:`PYTHONPATH` and
+run the :program:`bin/pgxn` script::
+
+ $ cd /path/to/pgxnclient
+ $ export PYTHONPATH=`pwd`
+ $ ./bin/pgxn --version
+ pgxnclient 1.0.3.dev0 # just an example
+
+.. __: http://pypi.python.org/pypi/pgxnclient/
+.. __: https://github.com/dvarrazzo/pgxnclient/
Please sign in to comment.
Something went wrong with that request. Please try again.