-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a7a9718
commit ee12c37
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |