diff --git a/README.md b/README.md index c58c9cd..454c071 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,16 @@ # Crazyflie CLI -This is a command line interface (CLI) for the Crazyflie 2.X written in Rust. It's intended to be used +This is a command line interface (CLI) for the Bitcraze Crazyflie written in Rust. It's intended to be used during development to easily log the console, set parameters and get logging variables. It's not intended to be used from any scripts to make the Crazyflie do things, then using the [Crazyflie python library](https://github.com/bitcraze/crazyflie-lib-python) is preferred. ## Installation -If you would like to install the CLI, you can do so by running the following command: +If you would like to install the cli for general use use the following command: ```text -git clone https://github.com/evoggy/cf-cli.git -cargo install --path cf-cli -``` - -Now the `cfcli` command should be available in your terminal. - -Or if you would like to run it from source use the following command: - -```text -git clone https://github.com/evoggy/cf-cli.git -cd cf-cli -cargo run -- -``` - -For example: - -```text -cargo run -- select +cargo install cfcli ``` ## Usage @@ -35,7 +18,7 @@ cargo run -- select To see how to use the CLI type ```cfcli``` in your terminal and you will get the following help message: ```text -Crazyflie CLI +Crazyflie command-line client Usage: cfcli [OPTIONS] @@ -53,13 +36,19 @@ Options: -V, --version Print version ``` -To use the CLI you must first select which URI to use, this is done by scanning for available Crazyflies +To use the CLI you must first select which URI to use, this is done by scanning for available Crazyflies and selecting the one you prefer. ```text cfcli select ``` +If you have a Crazyflie on a different address than the default you can specify it using the `-a` flag: + +```text +cfcli -a E7E7E7E7E7 select +``` + Now this URI will be used in all commands until a new one is selected. For instance a parameter can be set using the following command: @@ -71,5 +60,21 @@ And a log variable can be printed using the following command: ```text cfcli log print stabilizer.roll 100 +``` + + +## Development + +If you would like to run it from source use the following command: + +```text +git clone https://github.com/evoggy/cfcli.git +cd cfcli +cargo run -- +``` +For example: + +```text +cargo run -- select ```