Skip to content

Commit

Permalink
docs: update README with note on config file
Browse files Browse the repository at this point in the history
  • Loading branch information
enigbe committed Mar 11, 2024
1 parent 2f816b6 commit 5f5e075
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Install the CLI:
cargo install --locked --path sim-cli/
```

### Running the Simulation

To run the simulation, create a simulation file `sim.json` in the working directory (see [setup instructions](#simulation-file-setup) for details) and run:

```
Expand All @@ -49,6 +51,32 @@ sim-cli

Run `sim-cli -h` for details on `--data-dir` and `--sim-file` options that allow specifying custom simulation file locations.

Additionally, a configuration file can be used to specify runtime options. To set this up, create an `INI` file in the project root directory

```sh
$ touch conf.ini
```

Populate the `.ini` file with the options desired. For example:

```ini
// conf.ini
[simln.conf]
data_dir = /path/to/custom/data_dir
sim_file = /path/to/custom/sim_file
...
```

The default configuration file is `conf.ini`. To explicitly specify it or any other configuration file, use the command line argument as shown below.

```sh
$ sim-cli --config custom_config.ini
```

**Note**: The configuration keys used in the config file corresponds to the long format names of `sim-cli` options.

### Contributing

Interested in contributing to the project? See [CONTRIBUTING](CONTRIBUTING.md) for more details.

### Simulation File Setup
Expand Down

0 comments on commit 5f5e075

Please sign in to comment.