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

Add documentation about options

This commit is contained in:
Leni Aniva 2023-05-24 00:55:54 -07:00
parent fd536da55c
commit 4033722596
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -20,10 +20,10 @@ lake build mathlib
## Usage ## Usage
The binary must be run inside a `lake env` environment. i.e. `lake env The binary must be run inside a `lake env` environment. i.e. `lake env
build/bin/pantograph`. The REPL loop accepts commands as single-line JSON inputs build/bin/pantograph OPTIONS|MODULES`. The REPL loop accepts commands as
and outputs either an `Error:` (indicating malformed command) or a json return single-line JSON inputs and outputs either an `Error:` (indicating malformed
value indicating the result of a command execution. The command can be passed in command) or a json return value indicating the result of a command execution.
one of two formats The command can be passed in one of two formats
``` ```
command { ... } command { ... }
{ "cmd": command, "payload": ... } { "cmd": command, "payload": ... }
@ -31,7 +31,8 @@ command { ... }
The list of available commands can be found in `Pantograph/Commands.lean`. An The list of available commands can be found in `Pantograph/Commands.lean`. An
empty command aborts the REPL. empty command aborts the REPL.
The `Pantograph` executable must be run with a list of modules to import. The `Pantograph` executable must be run with a list of modules to import. It can
also accept options of the form `--key=value` e.g. `--pp.raw=true`.
Example: (~5k symbols) Example: (~5k symbols)
``` ```