Skip to content

Commit

Permalink
Installation docs.
Browse files Browse the repository at this point in the history
Fix #133
  • Loading branch information
Guillaume Smith committed Jul 4, 2019
1 parent ea99c5c commit 64df0c7
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,7 @@ This is as described by Rainer Schnell, Tobias Bachteler, and Jörg Reiher in

## Installation

Install clkhash with all dependencies using pip:

pip install clkhash

If the installation of `bitarray` fails on Windows you may need to install the appropriate
[Visual Studio C++ compiler](https://wiki.python.org/moin/WindowsCompilers) for your version
of Python; this is required because the `bitarray` library compiles a C extension.
[Installation](https://clkhash.readthedocs.io/en/latest/installation)

## Documentation

Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ clkhash: Cryptographic Linkage Key Hashing
``clkhash`` is a python implementation of cryptographic linkage key hashing as described by Rainer
Schnell, Tobias Bachteler, and Jörg Reiher in *A Novel Error-Tolerant Anonymous Linking Code* [Schnell2011]_.

Clkhash is Apache 2.0 licensed, supports Python versions 2.7+, 3.4+, and runs on Windows, OSX and Linux.
Clkhash is Apache 2.0 licensed, supports Python versions 2.7+, 3.5+, and runs on Windows, OSX and Linux.

Install with pip::

Expand All @@ -29,6 +29,7 @@ Table of Contents
.. toctree::
:maxdepth: 1

installation
tutorials
cli
schema
Expand Down
14 changes: 14 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Installation
============


Install ``clkhash`` with all dependencies using pip:

::

pip install clkhash


If the installation of ``bitarray`` fails on Windows you may need to install the appropriate
[Visual Studio C++ compiler](https://wiki.python.org/moin/WindowsCompilers) for your version
of Python; this is required because the `bitarray` library compiles a C extension.

0 comments on commit 64df0c7

Please sign in to comment.