diff --git a/README.md b/README.md index 8200308..9786b1f 100644 --- a/README.md +++ b/README.md @@ -4,37 +4,22 @@ A high altitude balloon flight simulator based on [tkschuler/EarthSHAB](https:// ## Installation ```sh -cargo install --git https://github.com/Brickworks/yahs.git -``` - -## Usage -```sh -export RUST_LOG=info # set the logging level [debug, info, warn] +cargo install --git https://github.com/Brickworks/yahs.git --features gui yahs --help ``` -## Run a simulated flight -### Configure the sim +## Usage (CLI) Set the simulation configuration in `config/default.toml` -### Start the sim Then use the `start` command to start a flight simulation. Use the `RUST_LOG` environment variable to specify the log level to report. + ```sh yahs start ``` -### View the flight data -First install the Brickworks support tooling, `firebrick`. -```sh -git clone git@github.com:Brickworks/firebrick.git -cd firebrick -pip install . +## Usage (GUI) -firebrick --help -``` -Then start up a telemetry dashboard. ```sh -firebrick dashboard -t $PATH_TO_TELEMETRY_CSV +yahs gui ``` -Then navigate to the server address specified in the log output.