Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
patricoferris authored Oct 3, 2023
1 parent a7a9718 commit ee12c37
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Weclome

Thank you for taking interest in this repository and considering contributing! If you need to get setup with OCaml please follow the excellent instructions at https://ocaml.org/docs.

## Installing Dependencies

After cloning the repository and `cd`-ing into it, you should be able to run

```
opam install . --deps-only --with-test
```

which will install the dependencies of the project.

## Building and Running the Tests

We use `dune` as the build tool for this repository. To build the project you can run `dune build` and to run the tests use `dune runtest`.

0 comments on commit ee12c37

Please sign in to comment.