Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rizo/ocaml-by-example
Code examples for OCaml.
https://github.com/rizo/ocaml-by-example
Last synced: 3 months ago
JSON representation
Code examples for OCaml.
- Host: GitHub
- URL: https://github.com/rizo/ocaml-by-example
- Owner: rizo
- License: bsd-3-clause
- Created: 2020-11-04T11:11:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-09T18:31:10.000Z (about 4 years ago)
- Last Synced: 2024-05-02T15:26:32.139Z (6 months ago)
- Language: OCaml
- Size: 16.6 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OCaml by example ⚡️
Code examples for OCaml.
## Requirements
Make sure that you have a working [opam](https://opam.ocaml.org) environment, follow the [official installation instructions](https://opam.ocaml.org/doc/Install.html).
Examples use the [dune](https://dune.build) build system and [odoc](https://github.com/ocaml/odoc) for documentation generation.
Install the required tools:
```
$ opam install dune odoc
```## Contributions
Fork this repository and open a pull request with small code examples to share it with others! Make sure that you document all the installation and execution instructions.
## Examples
- [hello-world](https://github.com/rizo/ocaml-by-example/tree/main/hello-world) - a small executable that prints a "hello world" message.
- [basic-lib-doc](https://github.com/rizo/ocaml-by-example/tree/main/basic-lib-doc) - a small executable and a library with documentation.