haskell/cryptonite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor grammatical updates

Browse Source
This commit is contained in:
John Galt 2016-04-21 10:40:09 -07:00
parent cb2440eaa5
commit cf96199b30
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -7,22 +7,20 @@ cryptonite
[![Haskell](http://b.repl.ca/v1/language-haskell-lightgrey.png)](http://haskell.org) [![Haskell](http://b.repl.ca/v1/language-haskell-lightgrey.png)](http://haskell.org)
Cryptonite is a haskell repository of cryptographic primitives. Each crypto Cryptonite is a haskell repository of cryptographic primitives. Each crypto
algorithm have specificities, that are hard to wrap in common APIs and types, algorithm has specificities that are hard to wrap in common APIs and types,
so instead of trying to provide a common ground for algorithms that wouldn't so instead of trying to provide a common ground for algorithms, this package
allow to provide all different usage or a really complicated system, this just provides a non-consistent low-level API.
provide a non-consistant low-level API.
If you have no idea what're you doing, please do not use this directly, rely on If you have no idea what you're doing, please do not use this directly.
higher level protocols or higher level implementation. Instead, rely on higher level protocols or implementations.
Documentation: [cryptonite on hackage](http://hackage.haskell.org/package/cryptonite) Documentation: [cryptonite on hackage](http://hackage.haskell.org/package/cryptonite)
Versioning Versioning
---------- ----------
Development versions are an incremental number prefixed by 0. Development versions are an incremental number prefixed by 0. There is no
No specific meaning is associated with the versions, specially API stability between development versions.
no API stability.
Production versions : TBD Production versions : TBD
@ -35,7 +33,7 @@ The coding style of this project mostly follows:
Support Support
------- -------
cryptonite supports the following platform: cryptonite supports the following platforms:
* Windows >= 8 * Windows >= 8
* OSX >= 10.8 * OSX >= 10.8
@ -55,21 +53,22 @@ On the following haskell versions:
* GHC 7.8.x * GHC 7.8.x
* GHC 7.10.x * GHC 7.10.x
Further platforms and architectures probably works too, but until maintainer(s) don't have regular Further platforms and architectures probably work too, but since the
access to them, we can't commit for further support maintainer(s) don't have regular access to them, we can't commit to
further support.
Known Building Issues Known Building Issues
--------------------- ---------------------
on OSX <= 10.7, the system compiler doesn't understand the '-maes' option, and On OSX <= 10.7, the system compiler doesn't understand the '-maes' option, and
with the lack of autodetection feature builtin in .cabal file, it is left on with the lack of autodetection feature builtin in .cabal file, it is left on
the user to disable the aesni. See the [Disabling AESNI] section the user to disable the aesni. See the [Disabling AESNI] section
Disabling AESNI Disabling AESNI
--------------- ---------------
It may be useful to disable AESNI (for building, testing or runtime purpose), and one can do that with the It may be useful to disable AESNI for building, testing or runtime purposes.
*support_aesni* flag. This is achieved with the *support_aesni* flag.
As part of configure of cryptonite: As part of configure of cryptonite: