From 7c428072610307de26ff5d81c70a29baaf0b309c Mon Sep 17 00:00:00 2001 From: okjodom Date: Wed, 15 Nov 2023 12:07:21 -0800 Subject: [PATCH] docs: update readme with instructions on running the simulation --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 40450a4d..5097bfa8 100644 --- a/README.md +++ b/README.md @@ -41,11 +41,14 @@ Install the CLI: cargo install --locked --path sim-cli/ ``` -Run with Simulation File (see [setup instructions](#simulation-file-setup) for details): - ``` -sim-cli sim.json +Run a simulation + +``` +sim-cli ``` +Run `sim-cli -h` to see configuration options available. See [setup instructions](#simulation-file-setup) for details on configuring the simulation file. + ### Simulation File Setup The simulator requires access details for a set of `nodes` that you have permission to execute commands on. Note that the current version @@ -190,10 +193,12 @@ described above). Activity sources and destinations may reference the *must* provide a valid public key. ### Simulation Output -A summary of the results will be logged by the simulator, and a full -list of payments made with their outcomes is available in -`simulation_{timestamp}.csv` in the directory that the simulation was -executed in. For more detailed logs, use the `--log-level` cli flag. + +A summary of the results will be logged by the simulator. A full list of payments made with their outcomes +is available in `simulation_{timestamp}.csv` within the configured `{data_dir}/results`. + +Run `sim-cli -h` for details on data directory (`--data-dir`) and other options including `--print-batch-size` +which affect how simulation outputs are persisted ## Lightning Environments If you're looking to get started with local lightning development, we