From 40337225963321abeabb59b899a3d54c709e90db Mon Sep 17 00:00:00 2001 From: Leni Aniva Date: Wed, 24 May 2023 00:55:54 -0700 Subject: [PATCH] Add documentation about options --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index baf8c33..f87d6f8 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,10 @@ lake build mathlib ## Usage 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 -and outputs either an `Error:` (indicating malformed command) or a json return -value indicating the result of a command execution. The command can be passed in -one of two formats +build/bin/pantograph OPTIONS|MODULES`. The REPL loop accepts commands as +single-line JSON inputs and outputs either an `Error:` (indicating malformed +command) or a json return value indicating the result of a command execution. +The command can be passed in one of two formats ``` command { ... } { "cmd": command, "payload": ... } @@ -31,7 +31,8 @@ command { ... } The list of available commands can be found in `Pantograph/Commands.lean`. An 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) ```