Skip to content

docs: add a headless first-run example and exit guidance #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rustfuture merged 1 commit into from
Oct 2, 2026
Merged

docs: add a headless first-run example and exit guidance #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,23 @@ grainx shows live computer and process activity in a terminal and can share thos

## Quick start

Requires stable Rust 1.88 or newer and an interactive terminal for the dashboard. The crate uses Rust edition 2024; the minimum version is checked against the committed dependency lockfile.
You need Git and stable Rust 1.88 or newer with Cargo ([rustup](https://rustup.rs/)), plus an interactive terminal for the dashboard. The first build downloads Cargo dependencies. The crate uses Rust edition 2024; the minimum version is checked against the committed dependency lockfile.

~~~bash
git clone https://github.com/rustfuture/grainx.git
cd grainx
cargo run --locked
~~~

The default command opens the dashboard. See [usage and project details](docs/readme-details.md) for configuration, commands, controls, metric definitions, demos, benchmarks, and compatibility notes.
The default command opens the dashboard; press `q` to quit. For a first check without an interactive terminal, export local readings instead:

~~~bash
cargo run --locked -- export --json /tmp/grainx-stats.json --csv /tmp/grainx-stats.csv
~~~

The command prints the two output paths. Open the JSON or CSV file to inspect the readings; no HTTP agent or external service is needed. On Windows, choose local output paths instead of `/tmp/...`; Windows is not covered by CI.

See [usage and project details](docs/readme-details.md) for configuration, commands, controls, metric definitions, demos, benchmarks, and compatibility notes.

## Architecture

Expand Down
Loading