QPQ-AG/enacl
10
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Delete this sentence. It serves no purpose.

Browse Source
This commit is contained in:
Jesper Louis Andersen 2020-02-06 16:18:25 +01:00
parent 8e628a61fc
commit 1f7d553f75
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -6,9 +6,6 @@ Frank Denis took the source and made it far more portable in the
libsodium library. The enacl project is somewhat misnamed, as it uses libsodium library. The enacl project is somewhat misnamed, as it uses
libsodium as the underlying driver. libsodium as the underlying driver.
Several Erlang ports of NaCl/libsodium exists, but this one is a
rewrite with the following foci:
## INSTALL/Requirements: ## INSTALL/Requirements:
* Erlang/OTP 17.3. This library *needs* the newest dirty scheduler * Erlang/OTP 17.3. This library *needs* the newest dirty scheduler
@ -21,11 +18,11 @@ rewrite with the following foci:
subpackages, make sure you also get the "-dev" package containing subpackages, make sure you also get the "-dev" package containing
the header files necessary in order to compile software linking to the header files necessary in order to compile software linking to
libsodium. libsodium.
To build the software execute: To build the software execute:
make make
or or
rebar compile rebar compile
@ -33,11 +30,11 @@ or
To build and run licensed eqc test execute: To build and run licensed eqc test execute:
make eqc_run make eqc_run
To build and run eqc-mini version of test execute: To build and run eqc-mini version of test execute:
make eqc_mini_run make eqc_mini_run
## Features: ## Features:
* Complete NaCl library, implementing all default functionality. * Complete NaCl library, implementing all default functionality.
@ -70,12 +67,12 @@ The original NaCl documentation is nowadays largely superceded by the
libsodium documentation, but it is still worth a visit libsodium documentation, but it is still worth a visit
https://nacl.cr.yp.to https://nacl.cr.yp.to
but also note that our interface has full Edoc documentation, but also note that our interface has full Edoc documentation,
generated by executing generated by executing
rebar3 doc rebar3 doc
## Hints ## Hints
In general, the primitives provided by NaCl are intermediate-level In general, the primitives provided by NaCl are intermediate-level
@ -283,5 +280,5 @@ no leaks in the code.
just the 3 main authors. Please see the page just the 3 main authors. Please see the page
http://nacl.cr.yp.to http://nacl.cr.yp.to
for the full list of authors. for the full list of authors.