aniva/Pantograph
aniva
/
Pantograph
1
1
Fork 0
Code Issues 10 Pull Requests 1 Packages Projects Releases 1 Wiki Activity

chore: Version bump and toolchain cleanup #51

Merged
aniva merged 4 commits from misc/toolchain into dev 2024-03-28 22:36:26 -07:00
Conversation 0 Commits 4 Files Changed 2 +13 -3
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 1d1a151a4b - Show all commits

16
README.md
View File

@ -1,9 +1,12 @@
# Pantograph
An interaction system for Lean 4.
A Machine-to-Machine interaction system for Lean 4.
![Pantograph](doc/icon.svg)
Pantograph provides interfaces to execute proofs, construct expressions, and
examine the symbol list of a Lean project for machine learning.
## Installation
For Nix based workflow, see below.
@ -109,9 +112,12 @@ ulimit -s unlimited
## Library Usage
`Pantograph/Library.lean` exposes a series of interfaces which allow FFI call
with `Pantograph`.
with `Pantograph` which mirrors the REPL commands above. It is recommended to
call Pantograph via this FFI since it provides a tremendous speed up.
## Testing
## Developing
### Testing
The tests are based on `LSpec`. To run tests,
``` sh
@ -120,6 +126,10 @@ make test
## Nix based workflow
The included Nix flake provides build targets for `sharedLib` and `executable`.
The executable can be used as-is, but linking against the shared library
requires the presence of `lean-all`.
To run tests:
``` sh
nix build .#checks.${system}.test