Skip to content

Commit 7b2fd2b

Browse files
committed
Update README
1 parent ba5e778 commit 7b2fd2b

7 files changed

+39
-35
lines changed

README.md

+39-35
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# GNOME HUD <sup>WIP</sup>
22

3-
<img src="./images/screenshot.png" height="200px">
4-
53
[GNOME Shell](https://www.gnome.org/) extension for displaying system information like CPU usage, RAM usage, GPU usage, and FPS.
64

5+
**Under active initial development, everything subject to change.**
6+
7+
**Screenshots**
8+
<details>
9+
<img src="./images/indicator-popup.png" height="200px">
10+
<p>Indicator Popup Menu</p>
11+
<img src="./images/overlay.png" height="200px">
12+
<p>Example Overlay</p>
13+
<img src="./images/preferences-1.png" height="200px">
14+
<p>Preferences Window (General)</p>
15+
<img src="./images/preferences-2.png" height="200px">
16+
<p>Preferences Window (Styles)</p>
17+
<img src="./images/preferences-3.png" height="200px">
18+
<p>Preferences Window (Monitors)</p>
19+
</details>
20+
721
## Installation
822

923
**Manual**
@@ -28,49 +42,24 @@ Use `Super` + `Alt` + `G` to toggle the overlay.
2842

2943
## Settings & Configuration
3044

31-
Extension settings can be accessed through the indicator in the status area with the 'Settings' button. Alternatively, open the settings dialog manually with `gnome-extensions prefs [email protected]`.
32-
33-
<details>
34-
<summary>Default Configuration</summary>
35-
36-
| Setting | Default | Type | Description |
37-
|---------|---------|------|-------------|
38-
| show-indicator | true | boolean | Show the top-panel indicator button |
39-
| show-overlay | true | boolean | Show the HUD overlay |
40-
| show-osd | true | boolean | Show toggle overlay alerts |
41-
| update-delay | 1000 | integer | Delay in milliseconds between overlay updates, 250-5000 |
42-
| anchor-corner | 1 | integer | Corner of the monitor to anchor the overlay to. 0 = top-left, 1 = top-right, 2 = bottom-left, 3 = bottom-right |
43-
| default-monitor | 0 | integer | Default monitor to display the overlay on. 0 = your primary monitor |
44-
| margin-v | 0.02 | double | Vertical margin in % of screen height |
45-
| margin-h | 0.02 | double | Horizontal margin in % of screen height |
46-
| overlay-h | 0.12 | double | Overlay height in % of screen height |
47-
| overlay-w | 0.12 | double | Overlay width in % of screen height |
48-
| background-color | "rgba(0, 0, 0)" | string | Background RGB color |
49-
| foreground-color | "rgba(255, 255, 255)" | string | Foreground RGB color |
50-
| background-opacity | 0.25 | double | Overlay background opacity, 0.00-1.00 |
51-
| foreground-opacity | 0.75 | double | Overlay foreground (font) opacity, 0.00-1.00 |
52-
| **Keybinds** |
53-
| kb-toggle-overlay | &lt;Super&gt;&lt;Alt&gt;g | keybind | Toggles overlay display (bound to show-overlay setting), special keys like &lt;Alt&gt; must be surrounded in &lt; &gt; |
54-
</details>
45+
Extension settings can be accessed through the indicator in the status area with the 'Settings' button. Alternatively, open the settings window manually with `gnome-extensions prefs [email protected]`.
5546

5647
## Development
5748

5849
### View logs
5950

60-
*GNOME Shell*
51+
**GNOME Shell**
52+
*GNOME shell, overlay, and indicator logs*
53+
6154
```
6255
journalctl -f -o cat /usr/bin/gnome-shell
6356
```
6457

65-
*GJS*
66-
```
67-
journalctl -f -o cat /usr/bin/gjs
68-
```
69-
70-
### Pack Extension
58+
**GJS**
59+
*Preferences window logs*
7160

7261
```
73-
gnome-extensions pack [email protected] --podir=po --extra-source={*.js}
62+
journalctl -f -o cat /usr/bin/gjs
7463
```
7564

7665
### Compile (Preferences) Schemas
@@ -83,4 +72,19 @@ glib-compile-schemas schemas/
8372

8473
```
8574
xgettext --from-code=UTF-8 --output=po/example.pot *.js
86-
```
75+
```
76+
77+
### Pack Extension
78+
79+
```
80+
gnome-extensions pack [email protected] --podir=po --extra-source={*.js}
81+
```
82+
83+
### Useful Links
84+
85+
| Name | Link |
86+
|------|------|
87+
| GJS Docs | https://gjs-docs.gnome.org/ |
88+
| GJS Guide | https://gjs.guide/extensions/ |
89+
| GNOME Shell Source | https://gitlab.gnome.org/GNOME/gnome-shell/-/tree/main/js/ui |
90+
| Icon Spec | https://specifications.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html |

images/indicator-popup.png

174 KB
Loading

images/overlay.png

288 KB
Loading

images/preferences-1.png

208 KB
Loading

images/preferences-2.png

217 KB
Loading

images/preferences-3.png

182 KB
Loading

images/screenshot.png

-236 KB
Binary file not shown.

0 commit comments

Comments
 (0)