From 12e4eeabd80c61c4e22307beb922daa70cffc6d6 Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Thu, 25 Jul 2013 11:59:50 -0700 Subject: [PATCH] added INSTALL and fixed markup in README --- INSTALL | 19 +++++++++++++++++++ README.md | 8 ++++---- 2 files changed, 23 insertions(+), 4 deletions(-) create mode 100644 INSTALL diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..3865f52 --- /dev/null +++ b/INSTALL @@ -0,0 +1,19 @@ +## Installation + +Clone repository or unpack the tar ball and install with +[setuptools](http://pythonhosted.org/setuptools/index.html) (note: if +you don't have setuptools installed you will need an internet +connection so that the installation procedure can sownload the +required files): + + cd propka-3.1 + python setup.py install --user + +This will install the `propka31` script in your executable directory, +as configured for setuptools, for instance `~/.local/bin`. You can +change the bin directory with the `--install-scripts` option. For +example, in order to install in my `bin` directory in my home +directory: + + python setup.py install --user --install-scripts ~/bin + diff --git a/README.md b/README.md index 78375a2..6e36338 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,11 @@ This release of PROPKA 3.1 was modified by Oliver Beckstein Clone repository or unpack the tar ball and install with [setuptools](http://pythonhosted.org/setuptools/index.html) (note: if you don't have setuptools installed you will need an internet -connection so that the installation procedure can sownload the +connection so that the installation procedure can download the required files): - cd propka-3.1 - python setup.py install --user + cd propka-3.1 + python setup.py install --user This will install the `propka31` script in your executable directory, as configured for setuptools, for instance `~/.local/bin`. You can @@ -45,7 +45,7 @@ change the bin directory with the `--install-scripts` option. For example, in order to install in my `bin` directory in my home directory: - python setup.py install --user --install-scripts ~/bin + python setup.py install --user --install-scripts ~/bin ## Requirements