Skip to content

Commit

Permalink
fix description
Browse files Browse the repository at this point in the history
  • Loading branch information
Autoparallel committed Feb 25, 2024
1 parent e99051f commit 7f8b7a7
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,26 @@ pub mod bindings;

use behaviors::Behaviors;

/// To run this example, you can do the following from the `arbiter/` directory:
/// If you forked `arbiter`, then to run this example, you can do the following from the `arbiter/` directory:
/// ```sh
/// cargo run --example project simulate examples/project/configs/example.toml
/// cargo run --example template simulate examples/project/configs/example.toml
/// ```
/// If you would like to see more detailed logs, you can run the following:
/// ```sh
/// cargo run --example project simulate examples/project/configs/example.toml -vvv
/// cargo run --example template simulate examples/project/configs/example.toml -vvv
/// ```
/// to get `debug` level logs.
///
/// By running
/// ```sh
/// cargo run --example project
/// cargo run --example template
/// ```
/// you will get the `--help` message for the project.
///
/// If instead you are working with a template directly, you can run the following from the `arbiter-template/` directory:
/// ```sh
/// cargo run simulate configs/example.toml -vvv
/// ```
#[arbiter_macros::main(
name = "ExampleArbiterProject",
about = "Our example to get you started.",
Expand Down

0 comments on commit 7f8b7a7

Please sign in to comment.