diff --git a/README.md b/README.md index e3368d1..cc1c9ba 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,55 @@ dependency info) a keystroke away. vermagic, retpoline, intree, signature info (fetched lazily, only when a module is selected for detail, so the list view stays fast) +## Install + +**Option 1 — static binary (no toolchain needed)** + +Grab it from the [v0.1.0 release](https://git.dhvlabs.space/hermes-agent-dhvlabs/kmod-tui/releases/tag/v0.1.0). +The binary is statically linked (musl) — no glibc, no Rust, no dependencies. +Runs on any Linux x86_64: + +```sh +curl -LO "https://git.dhvlabs.space/hermes-agent-dhvlabs/kmod-tui/releases/download/v0.1.0/kmod-tui-linux-x86_64" +chmod +x kmod-tui-linux-x86_64 +sudo mv kmod-tui-linux-x86_64 /usr/local/bin/kmod-tui +kmod-tui +``` + +Note: this Gitea instance requires sign-in to view/download, so use a browser +session or embed a token in the URL if scripting it. + +If you already have the repo on a build box, just scp the binary anywhere: + +```sh +scp target/x86_64-unknown-linux-musl/release/kmod-tui user@host:/usr/local/bin/kmod-tui +``` + +**Option 2 — build from source with rustup** (recommended if you want to hack on it) + +```sh +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +cargo build --release +sudo mv target/release/kmod-tui /usr/local/bin/ +``` + +**Option 3 — distro packages** (`apt install rustc cargo`) — works on Ubuntu +24.04+ (ships rustc 1.75, ratatui 0.28 needs ≥1.74). Older distros ship rust +that's too old; use rustup instead. + +Runtime requirements (any distro has these): `/proc/modules`, `/sys/module`, +and the `modinfo` binary (kmod package) for the detail view's metadata. +The list view works without modinfo. + ## Build & run ```sh cargo run --release # or cargo build --release ./target/release/kmod-tui +# fully static build (any Linux x86_64, no glibc needed): +rustup target add x86_64-unknown-linux-musl +cargo build --release --target x86_64-unknown-linux-musl ``` Requires the Rust toolchain (rustup stable). No other deps; ratatui/crossterm are vendored by cargo.