chore(doc): update README with better screenshots

graelo · Aug 2, 2023 · 939ca3f · 939ca3f
1 parent 573fa15
commit 939ca3f
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,31 @@ cargo install pumas
 sudo pumas run
 ```
 
-![Screenshot](./images/screenshot.png)
+Use the arrow keys to switch between tabs. Press `q` or `x` to quit.
+
+### Screenshots
+
+Overview Tab: global metrics for utilization and power consumption.
+
+![Overview](./images/screenshot-overview.png)
+
+CPU Tab: per-cluster CPU utilization (with short history) and frequency
+(with short history)
+
+![CPU](./images/screenshot-cpu.png)
+
+GPU Tab: GPU utilization (with short history) and frequency
+(with short history)
+
+![GPU](./images/screenshot-gpu.png)
+
+SoC Tab: misc info about the SoC
+
+![SoC](./images/screenshot-soc.png)
+
+Startup:
+
+![Startup](./images/screenshot-startup.png)
 
 ## Usage
 

diff --git a/images/screenshot-cpu.png b/images/screenshot-cpu.png
diff --git a/images/screenshot-gpu.png b/images/screenshot-gpu.png
diff --git a/images/screenshot-overview.png b/images/screenshot-overview.png
diff --git a/images/screenshot-soc.png b/images/screenshot-soc.png
diff --git a/images/screenshot-startup.png b/images/screenshot-startup.png
diff --git a/src/lib.rs b/src/lib.rs
@@ -38,7 +38,31 @@
 //! sudo pumas run
 //! ```
 //!
-//! ![Screenshot](./images/screenshot.png)
+//! Use the arrow keys to switch between tabs. Press `q` or `x` to quit.
+//!
+//! ### Screenshots
+//!
+//! Overview Tab: global metrics for utilization and power consumption.
+//!
+//! ![Overview](./images/screenshot-overview.png)
+//!
+//! CPU Tab: per-cluster CPU utilization (with short history) and frequency
+//! (with short history)
+//!
+//! ![CPU](./images/screenshot-cpu.png)
+//!
+//! GPU Tab: GPU utilization (with short history) and frequency
+//! (with short history)
+//!
+//! ![GPU](./images/screenshot-gpu.png)
+//!
+//! SoC Tab: misc info about the SoC
+//!
+//! ![SoC](./images/screenshot-soc.png)
+//!
+//! Startup:
+//!
+//! ![Startup](./images/screenshot-startup.png)
 //!
 //! ## Usage
 //!