aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 14 insertions, 7 deletions
diff --git a/README.md b/README.md
index 882b092..1b5da91 100644
--- a/README.md
+++ b/README.md
@@ -12,9 +12,9 @@ the [thesis archive](https://www.cs.ru.nl/bachelors-theses/) page of
12 12
13## Development 13## Development
14 14
15During my thesis, I used Nix to manage the Coq installation for this thesis. 15During my thesis, I used Nix to manage my Coq installation. If you use Nix, it
16If you use Nix, it should be easy to build/check the codebase. If not, this 16should be easy to build/check the codebase. If not, this might be a bit more
17might be a bit more tricky. 17tricky.
18 18
19There are two things that you need to have installed. The current `flake.lock` 19There are two things that you need to have installed. The current `flake.lock`
20ensures that we have the following software: 20ensures that we have the following software:
@@ -26,10 +26,12 @@ ensures that we have the following software:
26 26
27I have attached a `flake.nix` and `flake.lock` file, which should make my setup 27I have attached a `flake.nix` and `flake.lock` file, which should make my setup
28reproducible. Assuming a working Nix installation with flake support and the 28reproducible. Assuming a working Nix installation with flake support and the
29Nix command enabled, simply running `nix develop` followed by `make` should run 29Nix command enabled, simply running `nix develop` should give you a shell where
30`coqc` on all files. If you have a working [direnv](https://direnv.net/) 30the right Coq and Coq-std++ versions available.
31installation, simply running `direnv allow` (after inspecting the `.envrc` 31
32file) should make the right version of Coq and Coq-std++ available. 32If you have a working [direnv](https://direnv.net/) installation, simply
33running `direnv allow` (after inspecting the `.envrc` file) should make the
34right version of Coq and Coq-std++ available.
33 35
34### Without Nix 36### Without Nix
35 37
@@ -43,3 +45,8 @@ Coq-std++. However, your operating system's package repositories may also
43provide a package. Consider taking a look at the Repology pages: 45provide a package. Consider taking a look at the Repology pages:
44[coq-stdpp](https://repology.org/project/coq-stdpp/versions), 46[coq-stdpp](https://repology.org/project/coq-stdpp/versions),
45[coq:stdpp](https://repology.org/project/coq:stdpp/versions). 47[coq:stdpp](https://repology.org/project/coq:stdpp/versions).
48
49## Building/checking
50
51Running `make` should run `coqc` on all files; assuming that you are using a
52compatible Coq version, this should successfully check all proofs.