blob: 2500c9e92ed89e5cc5cc038664e145d0ada5f5c6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# OCaml Template
This is a template for OCaml projects.
## Quick Start
1. Fork this repository
2. Rename the repository to your project name
3. Replace all instances of `ocaml_template` with your project name, both in files and filenames themselves.
## Project Structure
```txt
.
├── _build # build outputs
├── bin # program entry points
├── docs # documentation
├── lib # public modules
├── test # tests
├── .editorconfig
├── .envrc
├── .gitignore
├── .ocamlformat # ocamlformat configuration
├── CODEOWNERS
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── Taskfile.yml # task runner configuration similar to make
├── dune-project # dune project configuration
├── flake.lock
├── flake.nix # nix flake configuration
├── ocaml_template.install # autogenerated install script
└── ocaml_template.opam # autogenerated project description
```
## Tools
- [task](https://taskfile.dev/)
- [dune](https://dune.build/)
- [opam](https://opam.ocaml.org/)
- [ocamlformat](https://ocaml.org/p/ocamlformat/latest/doc/index.html)
- [odoc](https://ocaml.github.io/odoc/odoc/index.html)
- [alchotest](https://github.com/mirage/alcotest)
- [bisect_ppx](https://github.com/aantron/bisect_ppx)
- [ocaml-lsp](https://github.com/ocaml/ocaml-lsp)
- [earlybird](https://github.com/ocaml-lsp/earlybird)
- [findlib](https://github.com/ocaml/ocamlfind)
- [menhir](https://github.com/ocaml-menhir/menhir)
- [re2](https://github.com/janestreet/re2)
- [fmt](https://erratique.ch/software/fmt)
## License
This project is licensed under the [Unlicense](https://unlicense.org/).
|
