Skip to content

Commit

Permalink
Merge pull request #53 from pmbittner/readme-submodule-hint
Browse files Browse the repository at this point in the history
Readme submodule hint
  • Loading branch information
pmbittner authored Jul 3, 2024
2 parents 4901863 + fe9e529 commit c7b746f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ We tested our setup on Manjaro, NixOS, Windows Subsystem for Linux (WSL2), and w
> In case of problems, there is a "Troubleshooting" section at the bottom of this file.
### Setup
Clone the library and its submodules to a directory of your choice:
```shell
git clone --recursive https://github.com/pmbittner/AgdaCCnOC.git
```

There are **three alternative ways** to compile the library and run its small demo.
**Either use **Nix, Docker, or install Agda manually.**
Expand Down Expand Up @@ -482,6 +486,16 @@ during a Docker build, you might have encountered an out of memory issue.
Try to rerun the same command after closing other applications which might comsume a lot of RAM.
In some cases it may also be necessary to disable some kind of out-of-memory killer (also known as OOM killer or OOM deamon) but use this option with caution.

### Failed to read library file ./libs/../agda-stdlib/standard-library.agda-lib.
The following error may occur when executing `make` after a manual setup:
```shell
Failed to read library file ./libs/../agda-stdlib/standard-library.agda-lib.
Reason: ./libs/../agda-stdlib/standard-library.agda-lib: openBinaryFile: does not exist (No such file or directory)
make: *** [makefile:15: build] Error 42
```
This error indicates that the `agda-stdlib` git submodule has not been set up correctly.
Executing `git submodule update --init` in the root of the repository should fix the problem.

[agda-badge-version-svg]: https://img.shields.io/badge/agda-v2.6.4.3-blue.svg
[agda-badge-version-url]: https://github.com/agda/agda/releases/tag/v2.6.4.3
[ghcup]: https://www.haskell.org/ghcup/
Expand Down

0 comments on commit c7b746f

Please sign in to comment.