From af00a35c5792632c1561f5cf92fca732c0705bc0 Mon Sep 17 00:00:00 2001 From: Juha Jeronen Date: Tue, 4 Apr 2017 15:15:48 +0300 Subject: [PATCH] README.md: add installation instructions --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index ec10c89..352bc43 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,43 @@ Currently only Python 2.7 is supported, but this may change in the future. Autom - FMA, as mentioned above. +## Installation + +### From PyPI (wlsqm v0.1.1+) + +Install as user: + +```bash +pip install wlsqm --user +``` + +Install as admin: + +```bash +sudo pip install wlsqm +``` + +Note that this package is currently compatible with Python 2.7 only, so you may need to use `pip2` instead of `pip` (which may default to Python 3). + +### From GitHub + +As user: + +```bash +git clone https://github.com/Technologicat/python-wlsqm.git +cd python-wlsqm +python setup.py install --user +``` + +As admin, change the last command to + +```bash +sudo python setup.py install +``` + +Here, too, may need to use `python2` instead of `python`. + + ## Documentation For usage examples, see [examples/wlsqm_example.py](examples/wlsqm_example.py) for a tour, and [examples/expertsolver_example.py](examples/expertsolver_example.py) for a minimal example concentrating specifically on `ExpertSolver`.