Skip to content

Commit

Permalink
edit kit README
Browse files Browse the repository at this point in the history
  • Loading branch information
Autoparallel committed Feb 21, 2024
1 parent a756474 commit a06a94d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions kit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ cargo run --bin kit
from the root of the repository.
Running this command will show the help menu for the `#[arbiter_macros::main]` macro.

If you want to run a specific simulation, you can do something like:
```bash
cargo run --bin kit simulation kit/configs/example.toml
```

## Pool
The `pool` module provides a generic `Pool<P: PoolType>` struct along with the `PoolType` trait.
The `PoolType` trait should be implemented for any of the distinct types of pools that DFMM offers.
Expand Down

0 comments on commit a06a94d

Please sign in to comment.