docs: clarify applet availability and server implementation status
Update README to specify that irtt-tui requires the tui feature and explicitly state that server support is not yet implemented.
This commit is contained in:
1 parent
170f229e7b
commit
ac82537043
2 files changed
+4
-5
No files matched your search
@@ -48,9 +48,9 @@ cargo run -p irtt-cli --bin irtt-cli -- <server>
|
||||
```
|
||||
|
||||
For space-sensitive packaging, such as OpenWrt packages, distributors can ship
|
||||
only `irtt-rs` and symlink or hardlink applet names such as `irtt-cli`,
|
||||
`irtt-tui`, and future server applet names to it. Applet dispatch is based on
|
||||
the invoked binary name.
|
||||
only `irtt-rs` and symlink or hardlink enabled applet names such as `irtt-cli`
|
||||
and, when built with the `tui` feature, `irtt-tui` to it. Applet dispatch is
|
||||
based on the invoked binary name. Server support is not implemented.
|
||||
|
||||
cargo-dist release archives are currently configured with the `full` feature
|
||||
set, so target archives bundle the enabled applet binaries: `irtt-rs`,
|
||||
|
||||
@@ -3,5 +3,4 @@ pub mod client;
|
||||
#[cfg(feature = "tui")]
|
||||
pub mod tui;
|
||||
|
||||
// Future command applets, such as a server applet, belong here behind their
|
||||
// own feature gate.
|
||||
// Additional command applets belong here behind their own feature gate.
|
||||
Reference in new issue
Block a user