doc: Remove stale documentation
This commit is contained in:
parent
b5cb4bfa57
commit
e8fdd906aa
14
README.md
14
README.md
|
@ -17,17 +17,21 @@ nix build .#{sharedLib,executable}
|
||||||
```
|
```
|
||||||
to build either the shared library or executable.
|
to build either the shared library or executable.
|
||||||
|
|
||||||
Install `lake` and `lean` fixed to the version of the `lean-toolchain` file, and
|
For non-Nix users, install `lake` and `lean` fixed to the version of the
|
||||||
run
|
`lean-toolchain` file, and run
|
||||||
|
|
||||||
``` sh
|
``` sh
|
||||||
lake build
|
lake build
|
||||||
```
|
```
|
||||||
This builds the executable in `.lake/build/bin/pantograph-repl`.
|
This builds the executable in `.lake/build/bin/repl`.
|
||||||
|
|
||||||
### Executable Usage
|
### Executable Usage
|
||||||
|
|
||||||
See [Executable Usage](./doc/repl.md)
|
The default build target is a Read-Eval-Print-Loop (REPL). See [REPL
|
||||||
|
Documentation](./doc/repl.md)
|
||||||
|
|
||||||
|
Another executable is the `tomograph`, which processes a Lean file and displays
|
||||||
|
syntax or elaboration level data.
|
||||||
|
|
||||||
### Library Usage
|
### Library Usage
|
||||||
|
|
||||||
|
@ -39,7 +43,7 @@ Inject any project path via the `pantograph_init_search` function.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
A Lean development shell is provided in the Nix flake.
|
A Lean development shell is provided in the Nix flake. Nix usage is optional.
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue