leonv/bsc-leon-vatthauer
1
0
Fork 0
mirror of https://git8.cs.fau.de/theses/bsc-leon-vatthauer.git synced 2024-05-31 07:28:34 +02:00
Code Issues Projects Releases Packages Wiki Activity

Added usage notes

Browse source
This commit is contained in:
Leon Vatthauer 2023-10-28 10:44:52 +00:00
parent 55e3e91d18
commit d61a4c8bfa
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -24,3 +24,18 @@ So far the contributions are:
## TODO ## TODO
TODOs are found inside the literate agda files! TODOs are found inside the literate agda files!
## Usage
The project requires a new version of agda-categories (newer than some package managers ship), so the easiest way to use this project is via the provided nix flake, which fetches my fork of agda-categories that is guaranteed to work with this project.
To use the project you just have to open a development shell:
```sh
nix develop .
```
(this will take 20 - 30 minutes the first time, because it has to typecheck the agda-categories library)
There is also a Makefile for compiling every module and generating the html documentation.
```
make
```