1
0
mirror of https://github.com/pcvolkmer/arsnova-client.git synced 2025-04-19 19:16:51 +00:00

docs: explain how to run the example application from source

This commit is contained in:
Paul-Christian Volkmer 2023-12-22 05:03:23 +01:00
parent 168717a78b
commit 5a12f79f93

View File

@ -56,8 +56,24 @@ client.on_feedback_changed( & cli.room, FeedbackHandler::Sender(tx.clone())).awa
See [`examples/arsnova-client-tui.rs`](examples/arsnova-client-tui.rs) for a simple terminal-based feedback client See [`examples/arsnova-client-tui.rs`](examples/arsnova-client-tui.rs) for a simple terminal-based feedback client
application. application.
```bash ### How to run
arsnova-client-tui 23269388
```shell
cargo run --example arsnova-client-tui
```
```
Terminal-based ARSnova live feedback client
Usage: arsnova-client-tui [OPTIONS] <ROOM>
Arguments:
<ROOM> Raum
Options:
-u, --url <URL> API-URL [default: https://ars.particify.de/api]
-h, --help Print help
-V, --version Print version
``` ```
![arsnova-client-tui](examples/arsnova-client.gif) ![arsnova-client-tui](examples/arsnova-client.gif)