Skip to content

Commit 64df0c7

Browse files
author
Guillaume Smith
committed
Installation docs.
Fix #133
1 parent ea99c5c commit 64df0c7

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,7 @@ This is as described by Rainer Schnell, Tobias Bachteler, and Jörg Reiher in
1313

1414
## Installation
1515

16-
Install clkhash with all dependencies using pip:
17-
18-
pip install clkhash
19-
20-
If the installation of `bitarray` fails on Windows you may need to install the appropriate
21-
[Visual Studio C++ compiler](https://wiki.python.org/moin/WindowsCompilers) for your version
22-
of Python; this is required because the `bitarray` library compiles a C extension.
16+
[Installation](https://clkhash.readthedocs.io/en/latest/installation)
2317

2418
## Documentation
2519

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ clkhash: Cryptographic Linkage Key Hashing
66
``clkhash`` is a python implementation of cryptographic linkage key hashing as described by Rainer
77
Schnell, Tobias Bachteler, and Jörg Reiher in *A Novel Error-Tolerant Anonymous Linking Code* [Schnell2011]_.
88

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

1111
Install with pip::
1212

@@ -29,6 +29,7 @@ Table of Contents
2929
.. toctree::
3030
:maxdepth: 1
3131

32+
installation
3233
tutorials
3334
cli
3435
schema

docs/installation.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Installation
2+
============
3+
4+
5+
Install ``clkhash`` with all dependencies using pip:
6+
7+
::
8+
9+
pip install clkhash
10+
11+
12+
If the installation of ``bitarray`` fails on Windows you may need to install the appropriate
13+
[Visual Studio C++ compiler](https://wiki.python.org/moin/WindowsCompilers) for your version
14+
of Python; this is required because the `bitarray` library compiles a C extension.

0 commit comments

Comments
 (0)