Add a basic CONTRIBUTING.md file

ocaml · May 17, 2024 · 46f1000 · 46f1000
1 parent 364fb19
commit 46f1000
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+### Developement setup
+
+Requirements:
+* nodejs
+* corepack (shipped with nodejs, however on some distributions it is not distributed, in which case install it through npm using: `npm install -g corepack`)
+
+To regenerated the compiled javascript files in `dist/`, call:
+```
+corepack enable
+yarn build
+```