Pantograph/README.md

44 lines
832 B
Markdown
Raw Normal View History

2023-05-09 22:51:19 -07:00
# Pantograph
An interaction system for Lean 4.
## Installation
Install `elan` and `lean4`. Then, execute
``` sh
lake build
```
2023-05-12 01:08:36 -07:00
In order to use `mathlib`, its binary must also be built
``` sh
2023-05-12 16:12:21 -07:00
lake build Qq
lake build aesop
2023-05-12 01:08:36 -07:00
lake build std
lake build mathlib
```
2023-05-09 22:51:19 -07:00
## Usage
2023-05-12 01:08:36 -07:00
The binary must be run inside a `lake env` environment.
2023-05-12 16:12:21 -07:00
Example: (~5k symbols)
```
$ lake env build/bin/Pantograph
{"cmd": "create", "payload": {"imports": ["Init"]}}
{"cmd": "catalog", "payload": {"id": 0}}
```
Example with `mathlib` (~90k symbols)
2023-05-12 01:08:36 -07:00
```
$ lake env build/bin/Pantograph
2023-05-09 22:51:19 -07:00
{"cmd": "create", "payload": {"imports": ["Mathlib.Analysis.Seminorm"]}}
2023-05-12 01:08:36 -07:00
{"cmd": "catalog", "payload": {"id": 0}}
2023-05-09 22:51:19 -07:00
```
2023-05-12 16:12:21 -07:00
2023-05-09 22:51:19 -07:00
2023-05-14 15:22:41 -07:00
## Troubleshooting
2023-05-09 22:51:19 -07:00
2023-05-14 15:22:41 -07:00
If lean encounters stack overflow problems when printing catalog, execute this before running lean:
```sh
ulimit -s unlimited
```