Updated readme with installation instructions and usage

This commit is contained in:
hellerve
2015-07-11 23:16:27 +02:00
parent 140dac9cbc
commit 59ba663ebe

View File

@@ -6,3 +6,28 @@ that is fully documented, occassionally improved and
embeddable into Python.
As you may notice, I am bad at documentation.
###Installation
The package has a setuptools toolchain, but is not (yet?) on pip,
which means that installation has to be performed manually. The
process looks like this:
```sh
git clone https://github.com/hellerve/IMProved
cd IMProved
python setup.py install
```
And you're good to go!
###Usage
Easy!
````python
import improved
improved.callIMP("n := 5")
# this will return a dictionary containing the key/value pair n/5
```