v1 implemented
it compiles
This commit is contained in:
60
README.md
Normal file
60
README.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# sloptop
|
||||
|
||||
`sloptop` is a Rust TUI resource monitor for Linux.
|
||||
|
||||
## Features
|
||||
|
||||
- CPU usage (total + per-core in detailed view)
|
||||
- Memory and swap usage
|
||||
- Disk usage per mounted disk
|
||||
- Network throughput (RX/TX bytes per second) and totals
|
||||
- Process count, uptime, host, and 1-minute load average
|
||||
- Adjustable refresh interval and pause/resume
|
||||
- Responsive layout for narrow terminals
|
||||
|
||||
## Build
|
||||
|
||||
Prerequisites:
|
||||
- Rust toolchain (`rustc` + `cargo`)
|
||||
|
||||
Build optimized binary:
|
||||
|
||||
```bash
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
Binary path:
|
||||
|
||||
```bash
|
||||
./target/release/sloptop
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
Default refresh interval is 1000 ms:
|
||||
|
||||
```bash
|
||||
cargo run -- --interval-ms 1000
|
||||
```
|
||||
|
||||
Accepted interval range: `200..=5000` ms.
|
||||
|
||||
## Keybindings
|
||||
|
||||
- `q` / `Esc`: quit
|
||||
- `p` / `Space`: pause/resume sampling
|
||||
- `+` / `=`: increase refresh interval by 200 ms
|
||||
- `-`: decrease refresh interval by 200 ms
|
||||
- `d`: toggle detailed view (shows per-core CPU list)
|
||||
|
||||
## Notes
|
||||
|
||||
- Target platform is Linux.
|
||||
- Network throughput is computed as a delta between consecutive samples.
|
||||
- Disk and network metrics are system-wide aggregates.
|
||||
|
||||
## Next steps
|
||||
|
||||
- Add top-process table with sorting/filtering
|
||||
- Add historical sparklines and alert thresholds
|
||||
- Extend platform-specific support and testing for macOS/Windows
|
||||
Reference in New Issue
Block a user