Skip to content

Commit

Permalink
chore(doc): update screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
graelo committed Mar 18, 2024
1 parent 6049dee commit d73f710
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 18 deletions.
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,23 @@ Use the arrow keys to switch between tabs. Press `Esc`, `q` or `x` to quit.

Overview Tab: global metrics for utilization and power consumption.

![Overview](./images/screenshot-overview.png)
![Overview dark](./images/screenshot-overview-dark.png)

![Overview light](./images/screenshot-overview-light.png)

CPU Tab: per-cluster CPU utilization (with short history) and frequency
(with short history)

![CPU](./images/screenshot-cpu.png)
![CPU-dark](./images/screenshot-cpu-dark.png)

![CPU-light](./images/screenshot-cpu-light.png)

GPU Tab: GPU utilization (with short history) and frequency
(with short history)

![GPU](./images/screenshot-gpu.png)
![GPU-dark](./images/screenshot-gpu-dark.png)

![GPU-light](./images/screenshot-gpu-light.png)

SoC Tab: misc info about the SoC

Expand Down Expand Up @@ -100,12 +106,26 @@ Run the power usage monitor
Usage: pumas run [OPTIONS]

Options:
-i, --sample-rate <SAMPLE_RATE_MS> Update rate (milliseconds): min: 100 [default: 1000]
--accent-color <ACCENT_COLOR> Accent color: ASCII code in 0~255 [default: 2]
--gauge-bg-color <GAUGE_BG_COLOR> Gauge background color: ASCII code in 0~255 [default: 7]
--json Print metrics to stdout as JSON instead of running the UI
-h, --help Print help (see more with '--help')
-V, --version Print version
-i, --sample-rate <SAMPLE_RATE_MS>
Update rate (milliseconds): min: 100 [default: 1000]
--history-size <HISTORY_SIZE>
History buffer size: default: 128 [default: 128]
--accent-color <ACCENT_COLOR>
Accent color for labels: ASCII code in 0~255, default: green [default: 2]
--gauge-fg-color <GAUGE_FG_COLOR>
Gauge foreground color: ASCII code in 0~255, default: green [default: 2]
--gauge-bg-color <GAUGE_BG_COLOR>
Gauge background color: ASCII code in 0~255, default: white [default: 7]
--history-fg-color <HISTORY_FG_COLOR>
History foreground color: ASCII code in 0~255, default: blue [default: 4]
--history-bg-color <HISTORY_BG_COLOR>
History background color: ASCII code in 0~255, default: white [default: 7]
--json
Print metrics to stdout as JSON instead of running the UI
-h, --help
Print help (see more with '--help')
-V, --version
Print version
```
### JSON Mode
Expand Down
Binary file added images/screenshot-cpu-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot-cpu-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/screenshot-cpu.png
Binary file not shown.
Binary file added images/screenshot-gpu-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot-gpu-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/screenshot-gpu.png
Binary file not shown.
Binary file added images/screenshot-overview-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot-overview-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/screenshot-overview.png
Binary file not shown.
38 changes: 29 additions & 9 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,23 @@
//!
//! Overview Tab: global metrics for utilization and power consumption.
//!
//! ![Overview](./images/screenshot-overview.png)
//! ![Overview dark](./images/screenshot-overview-dark.png)
//!
//! ![Overview light](./images/screenshot-overview-light.png)
//!
//! CPU Tab: per-cluster CPU utilization (with short history) and frequency
//! (with short history)
//!
//! ![CPU](./images/screenshot-cpu.png)
//! ![CPU-dark](./images/screenshot-cpu-dark.png)
//!
//! ![CPU-light](./images/screenshot-cpu-light.png)
//!
//! GPU Tab: GPU utilization (with short history) and frequency
//! (with short history)
//!
//! ![GPU](./images/screenshot-gpu.png)
//! ![GPU-dark](./images/screenshot-gpu-dark.png)
//!
//! ![GPU-light](./images/screenshot-gpu-light.png)
//!
//! SoC Tab: misc info about the SoC
//!
Expand Down Expand Up @@ -90,12 +96,26 @@
//! Usage: pumas run [OPTIONS]
//!
//! Options:
//! -i, --sample-rate <SAMPLE_RATE_MS> Update rate (milliseconds): min: 100 [default: 1000]
//! --accent-color <ACCENT_COLOR> Accent color: ASCII code in 0~255 [default: 2]
//! --gauge-bg-color <GAUGE_BG_COLOR> Gauge background color: ASCII code in 0~255 [default: 7]
//! --json Print metrics to stdout as JSON instead of running the UI
//! -h, --help Print help (see more with '--help')
//! -V, --version Print version
//! -i, --sample-rate <SAMPLE_RATE_MS>
//! Update rate (milliseconds): min: 100 [default: 1000]
//! --history-size <HISTORY_SIZE>
//! History buffer size: default: 128 [default: 128]
//! --accent-color <ACCENT_COLOR>
//! Accent color for labels: ASCII code in 0~255, default: green [default: 2]
//! --gauge-fg-color <GAUGE_FG_COLOR>
//! Gauge foreground color: ASCII code in 0~255, default: green [default: 2]
//! --gauge-bg-color <GAUGE_BG_COLOR>
//! Gauge background color: ASCII code in 0~255, default: white [default: 7]
//! --history-fg-color <HISTORY_FG_COLOR>
//! History foreground color: ASCII code in 0~255, default: blue [default: 4]
//! --history-bg-color <HISTORY_BG_COLOR>
//! History background color: ASCII code in 0~255, default: white [default: 7]
//! --json
//! Print metrics to stdout as JSON instead of running the UI
//! -h, --help
//! Print help (see more with '--help')
//! -V, --version
//! Print version
//! ```
//!
//! ### JSON Mode
Expand Down

0 comments on commit d73f710

Please sign in to comment.