CatalaLang/catala
1
1
Fork 0
mirror of https://github.com/CatalaLang/catala.git synced 2024-09-19 16:28:12 +03:00
Code Issues Projects Releases Wiki Activity

update nix documentation

Browse Source
This commit is contained in:
adelaett 2023-01-19 11:31:45 -05:00
parent 839f2e19d5
commit 2012f352b2
No known key found for this signature in database
GPG Key ID: 0D4F3CEF398F7CC0
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
INSTALL.md
View File

@ -22,18 +22,31 @@ Finally, start a shell inside a new container created from the newly built image
The repository provides nix files to build or develop the catala compiler.
Once [nix is installed](https://nixos.org/manual/nix/stable/#ch-installing-binary),
it is possible to enter a development shell:
with flakes enabled it is possible to enter a development shell:
nix-shell
nix develop
or to build the Catala compiler, documentation and runtime library:
nix-build release.nix
nix build
Dependencies not yet in nixpkgs (`bindlib` and `unionFind` at the moment of writing)
are hardcoded inside the `.nix` directory. The `default.nix` should be compatible with
Dependencies not yet in nixpkgs (`ubase` and `unionFind` at the moment of writing)
are hardcoded inside the `.nix` directory. The `.nix/catala.nix` should be compatible with
nixpkgs, if it finds a maintainer.
To develop catala's compiler using vscode using ocaml's [lsp](https://microsoft.github.io/language-server-protocol/), you can use the [ocaml-platform extension](https://marketplace.visualstudio.com/items?itemName=ocamllabs.ocaml-platform) with the following settings (inside the file `.vscode/settings.json`).
```json
{
"ocaml.sandbox": {
"kind": "custom",
"template": "nix develop --command $prog $args"
},
}
```
The nix build is updated weekly by an automatic github action.
### With opam
The Catala compiler is written using OCaml. First, you have to install `opam`,