diff --git a/README.md b/README.md index 687773c..be5d880 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,6 @@ # abp 0.6.0 Python port of Anders and Briegel' s [method](https://arxiv.org/abs/quant-ph/0504117) for fast simulation of Clifford circuits. -## Documentation -You can read the full documentation [here](https://peteshadbolt.co.uk/static/abp/). You can also build it locally using Sphinx with `make doc`. - -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 Install from source @@ -17,3 +12,8 @@ $ virtualenv env $ source env/bin/activate $ python setup.py develop --user ``` + +## Documentation +You can read the full documentation [here](https://peteshadbolt.co.uk/static/abp/). You can also build it locally using Sphinx with `make doc`. + +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`.