Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to Dune #24

Merged
merged 22 commits into from
Oct 9, 2020
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ setup.data
setup.log
*.native
*~
.merlin
41 changes: 0 additions & 41 deletions Makefile

This file was deleted.

26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,28 @@ This library is distributed under the conditions of the GNU Library General Publ
## Requirements

* OCaml 4.02 or more recent.
* The findlib/ocamlfind tool.
* The OASIS tool.
* The Dune build system, version 2.0 or more recent.
* The Zarith library, version 1.4 or more recent.
* The Zlib C library, version 1.1.3 or up is recommended. If it is not installed on your system (look for libz.a or libz.so), get it from http://www.gzip.org/, or indicate in the Makefile that you do not have it. If you are running Linux or BSD or MacOS, your distribution provides precompiled binaries for this library.
* If the operating system does not provide the `/dev/random` device for random number generation, consider installing the [EGD](http://egd.sourceforge.net/) entropy gathering daemon. Without `/dev/random` nor EGD, this library cannot generate cryptographically-strong random data nor RSA keys. The remainder of the library still works, though.

## Installation
## Build, test and install

```
./configure --enable-tests
make
make test
make install
```
* To build, run `dune build`.

## Documentation
* To execute a test, run `dune exec test/<name>.exe` where `<name>` can be `test`,
`prngtest` or `speedtest`, supplying additional command line arguments if needed.
The main test file `test/test.ml` is also included into the `runtest` alias, so it
can be executed simply by `dune test`.

* To install, run `dune install`.

See the extensive documentation comments in file src/cryptokit.mli.
## Documentation

Compilation options: `ocamlfind ocamlopt -package cryptokit`...
See the extensive documentation comments in file `src/cryptokit.mli`.

Linking options: `ocamlfind ocamlopt -linkpkg -package cryptokit`...
To build HTML documentation, run `dune build @doc`. The resulting index file is
located at `_build/default/_doc/_html/cryptokit/Cryptokit/index.html`.

## Warnings and disclaimers

Expand Down
148 changes: 0 additions & 148 deletions _oasis

This file was deleted.

128 changes: 0 additions & 128 deletions _tags

This file was deleted.

27 changes: 0 additions & 27 deletions configure

This file was deleted.

Loading