41 lines
802 B
Markdown
41 lines
802 B
Markdown
|
# permap
|
||
|
|
|
||
|
|
permap is an [OCaml] executable/library to TODO.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
`permap` can be installed with [opam]:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
opam install permap
|
||
|
|
```
|
||
|
|
|
||
|
|
If you don't have `opam`, you can install it following the [how to install opam] guide.
|
||
|
|
|
||
|
|
If you can't or don't want to use `opam`, consult the [opam file] for build instructions.
|
||
|
|
|
||
|
|
## Quickstart
|
||
|
|
|
||
|
|
```ocaml
|
||
|
|
let () = Format.printf "TODO@."
|
||
|
|
```
|
||
|
|
|
||
|
|
For more, have a look at the [example] folder, at the [documentation] or at the [test suite].
|
||
|
|
|
||
|
|
## About
|
||
|
|
|
||
|
|
- [LICENSE]
|
||
|
|
- [CHANGELOG]
|
||
|
|
|
||
|
|
[CHANGELOG]: ./CHANGES.md
|
||
|
|
[example]: ./example/
|
||
|
|
[LICENSE]: ./LICENSE.md
|
||
|
|
[opam file]: ./permap.opam
|
||
|
|
[test suite]: ./test/
|
||
|
|
|
||
|
|
[documentation]: TODO
|
||
|
|
[how to install opam]: https://opam.ocaml.org/doc/Install.html
|
||
|
|
[OCaml]: https://ocaml.org
|
||
|
|
[opam]: https://opam.ocaml.org/
|
||
|
|
[permap]: TODO
|