From 7f8b7a785a1f8e6e70f5b3cd81dd091f31e37de5 Mon Sep 17 00:00:00 2001 From: Colin Roberts <colin@primitive.xyz> Date: Sun, 25 Feb 2024 10:18:57 -0700 Subject: [PATCH] fix description --- src/main.rs | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/main.rs b/src/main.rs index ed16fb9..e3193a2 100644 --- a/src/main.rs +++ b/src/main.rs @@ -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.",