Skip to content

Commit 6511e44

Browse files
committed
Add some more notes about the Idris sketch
1 parent 9f0cd55 commit 6511e44

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

experiments/idris/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,26 @@
22

33
Some sketches of Fathom’s core language using Idris as a logical framework.
44

5+
> **Note:**
6+
>
7+
> Idris 2 does not yet support cumulatively or full totality checking, so the
8+
> definitions here may depend on inconsistency. We also don’t aim to prove any
9+
> properties of these definitions, this is more intended for experimentation.
10+
11+
## Development setup
12+
13+
Depends on the following:
14+
15+
- [Idris 2](https://github.com/idris-lang/Idris2/blob/main/INSTALL.md)
16+
- [rlwrap](https://github.com/hanslub42/rlwrap) (optional - as a workaround for
17+
[idris-lang/Idris2#54](https://github.com/idris-lang/Idris2/issues/54))
18+
19+
If you use NixPkgs the above is installed as part of the default development
20+
shell in the [flake.nix](../../flake.nix) provided.
21+
22+
## Usage
23+
524
```command
6-
$ idris2 --repl experiments/idris/fathom.ipkg
25+
$ rlwrap idris2 --repl experiments/idris/fathom.ipkg
726
Main> :load "src/Playground.idr"
827
```

0 commit comments

Comments
 (0)