summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2015-06-21 08:35:46 -0500
committerPaul Kehrer <paul.l.kehrer@gmail.com>2015-06-21 08:35:46 -0500
commit3e147a7d69757c3b5190281faeb0d20cd5625524 (patch)
treebccda0bb6ccf98cf22a282d087b17e0a1b261a6e /README.rst
parentf204d426bd4c364e80c6b59b27a12aaf48d6bb23 (diff)
parent20f712ebb81da0084c5ba51463133a1867d2729a (diff)
downloadpy-bcrypt-git-3e147a7d69757c3b5190281faeb0d20cd5625524.tar.gz
Merge pull request #46 from chris-erickson/patch-1
Update README to include additional install steps
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 1fa3bbd..37bb482 100644
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,7 @@
bcrypt
======
-.. image:: https://pypip.in/version/bcrypt/badge.svg?style=flat
+.. image:: https://img.shields.io/pypi/v/bcrypt.svg
:target: https://pypi.python.org/pypi/bcrypt/
:alt: Latest Version
@@ -20,6 +20,19 @@ To install bcrypt, simply:
$ pip install bcrypt
+Note that bcrypt should build very easily on Linux provided you have a C compiler, headers for Python (if you’re not using pypy), and headers for the libffi libraries available on your system.
+
+For Debian and Ubuntu, the following command will ensure that the required dependencies are installed:
+
+.. code:: bash
+
+ $ sudo apt-get install build-essential libffi-dev python-dev
+
+For Fedora and RHEL-derivatives, the following command will ensure that the required dependencies are installed:
+
+.. code:: bash
+
+ $ sudo yum install gcc libffi-devel python-devel
Usage
-----