From eeb28de4e3fcdcf8b1ac78da03b9dcf05f3ff5da Mon Sep 17 00:00:00 2001 From: Pete Shadbolt Date: Thu, 7 Mar 2019 14:32:28 -0800 Subject: [PATCH] Readme --- .gitignore | 1 + README.md | 22 ++++------------------ 2 files changed, 5 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index 9dbae15..ba183c7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.eggs/ README scripts/ chp/ diff --git a/README.md b/README.md index 66521a3..687773c 100644 --- a/README.md +++ b/README.md @@ -7,27 +7,13 @@ You can read the full documentation [here](https://peteshadbolt.co.uk/static/abp To install Sphinx on OSX, use `pip install sphinx`. If after doing so `make doc` still does not work, some OSX users may also need to install `sphinxcontrib-napoleon` by running `pip install sphinxcontrib-napoleon`. ## Installation -It's easiest to install with `pip`: -```shell -$ pip install --user abp==0.6.0 -``` - -Or install from source: clone and install in `develop` mode: +Install from source ```shell -$ git clone https://github.com/peteshadbolt/abp.git +$ git clone http://gitlab.psiquantum.lan/pete/abp $ cd abp +$ virtualenv env +$ source env/bin/activate $ python setup.py develop --user -$ python setup.py develop --user --prefix= # Might be required on OSX ``` -If installed from source, check that abp is running your local Python install by ensuring that the first line of `abp/bin/abpserver` matches your local python install (which can be found using `which python`). If not, you will need to change it to your local python path. - -Some OSX users may find they need additional modifications to their path to execute `abpserver` from the command line. To add `abpserver` to your path, you must first find where it is installed, e.g. by typing: - -```shell -$ find / -iname "abpserver" -``` -A path to a Python library, such as `/Users/username/Library/Python/2.7/bin/abpserver`, should appear (if installed from source, this is not `path/to/repo/abp/bin/abpserver`). To add this to your path permanently, open `~/.bash_profile`, add the path, e.g. `export PATH="$HOME/Library/Python/2.7/bin:$PATH"` and restart your shell. If this has worked, typing `which abpserver` will display the desired path. - -