Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@hynek
hynek committed Dec 18, 2015
1 parent d3f6eed commit 69a7398
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Generally speaking,
should be all it takes.

But since Argon2 isn't packaged on any major distribution yet, ``argon2_cffi`` vendors its C code which depending on the platform can lead to complications.
But since Argon2 (the C library) isn't packaged on any major distribution yet, ``argon2_cffi`` vendors its C code which depending on the platform can lead to complications.

The C code is known to compile and work on all common platforms (including x86, ARM, and PPC).
On x86, an SSE2_-optimized version is used.
Expand All @@ -31,12 +31,10 @@ With a recent-enough ``pip`` and ``setuptools``, they should be used automatical
Linux
-----

A working C compiler is required.
A working C compiler and `CFFI environment`_ is required.
If you've been able to compile Python CFFI extensions before, ``argon2_cffi`` should install without any problems.

Also please note CFFI's dependencies_.


.. _SSE2: https://en.wikipedia.org/wiki/SSE2
.. _PyPI: https://pypi.python.org/pypi/argon2_cffi/
.. _dependencies: https://cffi.readthedocs.org/en/latest/installation.html#platform-specific-instructions
.. _CFFI environment: https://cffi.readthedocs.org/en/latest/installation.html

0 comments on commit 69a7398

Please sign in to comment.