Skip to content

Commit 6cf27d0

Browse files
committed
docs: Format README.md with markdownlint
1 parent 722077d commit 6cf27d0

File tree

1 file changed

+49
-43
lines changed

1 file changed

+49
-43
lines changed

docs/README.md

Lines changed: 49 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# G-Helper - Lightweight control tool for Asus laptops
2+
23
[![United24](https://raw.githubusercontent.com/seerge/g-helper/main/docs/ua.png)](https://u24.gov.ua/)
3-
[![GitHub release](https://img.shields.io/github/release/seerge/g-helper)](https://GitHub.com/seerge/g-helper/releases/)
4+
[![GitHub release](https://img.shields.io/github/release/seerge/g-helper)](https://GitHub.com/seerge/g-helper/releases/)
45
[![Github all releases](https://img.shields.io/github/downloads/seerge/g-helper/total)](https://GitHub.com/seerge/g-helper/releases/) [![GitHub stars](https://img.shields.io/github/stars/seerge/g-helper.svg?style=social)](https://GitHub.com/seerge/g-helper/stargazers/) <sup>[中文版点这里](https://github.com/seerge/g-helper/blob/main/docs/README.zh-CN.md)</sup> <sup>[日本語はこちら](https://github.com/seerge/g-helper/blob/main/docs/README.ja-JP.md)</sup>
56

6-
Small and lightweight Armoury Crate alternative for Asus laptops offering almost same functionality with a much smaller footprint. Works with all popular models, such as ROG Zephyrus G14, G15, G16, M16, Flow X13, Flow X16, Flow Z13, DUO, TUF Series, Strix or Scar Series, ProArt, Vivobook, Zenbook, Expertbook, ROG Ally or Ally X and many more!
7+
Small and lightweight Armoury Crate alternative for Asus laptops offering almost same functionality with a much smaller footprint. Works with all popular models, such as ROG Zephyrus G14, G15, G16, M16, Flow X13, Flow X16, Flow Z13, DUO, TUF Series, Strix or Scar Series, ProArt, Vivobook, Zenbook, Expertbook, ROG Ally or Ally X and many more!
8+
9+
## [:floppy_disk: Download](https://github.com/seerge/g-helper/releases/latest/download/GHelper.zip)
710

8-
# [:floppy_disk: Download](https://github.com/seerge/g-helper/releases/latest/download/GHelper.zip)
9-
**⭐ If you like the app - please spread the word about it online**
11+
**⭐ If you like the app - please spread the word about it online.**
1012

1113
<table>
1214
<tr>
@@ -25,23 +27,24 @@ Small and lightweight Armoury Crate alternative for Asus laptops offering almost
2527
- [Troubleshooting](https://github.com/seerge/g-helper/wiki/Troubleshooting)
2628
- [Power User Settings](https://github.com/seerge/g-helper/wiki/Power-user-settings)
2729

28-
2930
[![G-Helper Download](https://github.com/seerge/g-helper/assets/5920850/4d98465a-63a5-4498-ae14-afb3e67e7e82)](https://github.com/seerge/g-helper/releases/latest/download/GHelper.zip)
3031

3132
## :loudspeaker: YouTube Reviews and Guides
33+
3234
| [![Youtube review Josh Cravey](https://i.ytimg.com/vi/hqe-PjuE-K8/hqdefault.jpg)](https://www.youtube.com/watch?v=hqe-PjuE-K8) | [![Youtube review cbutters Tech](https://i.ytimg.com/vi/6aVdwJKZSSc/hqdefault.jpg)](https://www.youtube.com/watch?v=6aVdwJKZSSc) |
33-
| ----------------- | ---------------- |
34-
| [Josh Cravey](https://www.youtube.com/watch?v=hqe-PjuE-K8) | [cbutters Tech](https://www.youtube.com/watch?v=6aVdwJKZSSc) |
35+
| ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
36+
| [Josh Cravey](https://www.youtube.com/watch?v=hqe-PjuE-K8) | [cbutters Tech](https://www.youtube.com/watch?v=6aVdwJKZSSc) |
3537

3638
## 📰 Articles
37-
1. https://www.digitaltrends.com/computing/g-helper-armoury-crate-alternative/
38-
2. https://binaryfork.com/ghelper-armoury-crate-alternative-10216/
3939

40-
## :gift: Advantages
40+
1. <https://www.digitaltrends.com/computing/g-helper-armoury-crate-alternative/>
41+
2. <https://binaryfork.com/ghelper-armoury-crate-alternative-10216/>
42+
43+
## :gift: Advantages
4144

4245
1. Seamless and automatic GPU switching
4346
2. All performance modes can be fully customized with power limits and fan curves
44-
3. Lightweight. Just a single exe to run. Doesn't install anything in your system.
47+
3. Lightweight. Just a single exe to run. Doesn't install anything in your system.
4548
4. Simple and clean native UI with easy access to all settings
4649
5. FN-Lock and custom hotkeys
4750

@@ -51,10 +54,10 @@ Small and lightweight Armoury Crate alternative for Asus laptops offering almost
5154

5255
1. Performance modes: Silent - Balanced - Turbo (built-in, with default fan curves)
5356
2. GPU modes: Eco - Standard - Ultimate - Optimized
54-
3. Screen refresh rate control with display overdrive (OD)
57+
3. Screen refresh rate control with display overdrive (OD)
5558
4. Custom fan curve editor, power limits and turbo boost selection for every performance mode
5659
5. Anime Matrix or Slash Lighting control including animated GIFs, clock and Audio visualizer
57-
6. Backlight animation modes and colors
60+
6. Backlight animation modes and colors
5861
7. Hotkey handling
5962
8. Monitor CPU and GPU temperature, fan speeds and battery status
6063
9. Battery charge limit to preserve battery health
@@ -67,23 +70,23 @@ Small and lightweight Armoury Crate alternative for Asus laptops offering almost
6770
16. Flicker-free dimming and Visual Modes
6871

6972
### :gear: Automation
73+
7074
- Performance Mode switching when on battery or plugged in
7175
- Optimized GPU mode - disables dGPU on battery and enables when plugged in
7276
- Auto Screen refresh rate (60Hz on battery and max Hz when plugged)
7377
- Keyboard backlight timeout on battery or when plugged in
7478

7579
### :rocket: Performance Modes
7680

77-
<img align="right" width="300" src="https://github.com/seerge/g-helper/assets/5920850/3e119674-db8d-486b-aa65-2bf9b61f9aa6">
81+
<img align="right" width="300" src="https://github.com/seerge/g-helper/assets/5920850/3e119674-db8d-486b-aa65-2bf9b61f9aa6" alt="Power & battery in Windows Settings">
7882

7983
All Modes are **baked in BIOS** along with default fan curves and power limits and they are the **same** as in the Armoury Crate.
8084

81-
Each BIOS mode is paired with matching Windows Power Mode. You can adjust this setting under ``Fans + Power``
85+
Each BIOS mode is paired with matching Windows Power Mode. You can adjust this setting under `Fans + Power`
8286

8387
1. **Silent** in BIOS + **Best power efficiency** power mode
8488
2. **Balanced** (Performance in AC) in BIOS + **Balanced** power mode
8589
3. **Turbo** in BIOS + **Best performance** power mode
86-
8790

8891
### :video_game: GPU Modes
8992

@@ -96,10 +99,10 @@ Each BIOS mode is paired with matching Windows Power Mode. You can adjust this s
9699

97100
![GPU Modes](https://github.com/seerge/g-helper/assets/5920850/65c6bdd5-728c-4965-b544-fcf5a85ed6a2)
98101

99-
100102
### :mouse: Asus Mouse and other peripherals support
101103

102104
[Currently supported models](https://github.com/seerge/g-helper/discussions/900)
105+
103106
- ROG Chakram X (P708)
104107
- ROG Chakram Core (P511)
105108
- ROG Gladius II and Gladius II Origin (P502 and P504)
@@ -127,39 +130,40 @@ Huge thanks to [@IceStormNG](https://github.com/IceStormNG) 👑 for contributio
127130

128131
### ⌨️ Keybindings
129132

130-
- ``Fn + F5 / Fn + Shift + F5`` - Toggle Performance Modes forwards / backwards
131-
- ``Ctrl + Shift + F5 / Ctrl + Shift + Alt + F5`` - Toggle Performance Modes forwards / backwards
132-
- ``Ctrl + Shift + F12`` - Open G-Helper window
133-
- ``Ctrl + M1 / M2`` - Screen brightness Down / Up
134-
- ``Shift + M1 / M2`` - Backlight brightness Down / Up
135-
- ``Fn + C`` - Fn-Lock
136-
- ``Fn + Ctrl + F7 / F8`` - Flicker-free dimming Down / Up
137-
- ``Fn + Shift + F7 / F8`` - Matrix / Slash Lighting brightness Down / Up
138-
- ``Fn + Shift + F7 / F8`` - Screenpad brightness Down / Up
139-
- ``Ctrl + Shift + F20`` - Mute Microphone
140-
- ``Ctrl + Shift + Alt + F13`` - Toggle Display Refresh Rate
141-
- ``Ctrl + Shift + Alt + F14`` - Eco GPU Mode
142-
- ``Ctrl + Shift + Alt + F15`` - Standard GPU Mode
143-
- ``Ctrl + Shift + Alt + F16`` - Silent
144-
- ``Ctrl + Shift + Alt + F17`` - Balanced
145-
- ``Ctrl + Shift + Alt + F18`` - Turbo
146-
- ``Ctrl + Shift + Alt + F19`` - Custom 1 (if exists)
147-
- ``Ctrl + Shift + Alt + F20`` - Custom 2 (if exists)
133+
- `Fn + F5 / Fn + Shift + F5` - Toggle Performance Modes forwards / backwards
134+
- `Ctrl + Shift + F5 / Ctrl + Shift + Alt + F5` - Toggle Performance Modes forwards / backwards
135+
- `Ctrl + Shift + F12` - Open G-Helper window
136+
- `Ctrl + M1 / M2` - Screen brightness Down / Up
137+
- `Shift + M1 / M2` - Backlight brightness Down / Up
138+
- `Fn + C` - Fn-Lock
139+
- `Fn + Ctrl + F7 / F8` - Flicker-free dimming Down / Up
140+
- `Fn + Shift + F7 / F8` - Matrix / Slash Lighting brightness Down / Up
141+
- `Fn + Shift + F7 / F8` - Screenpad brightness Down / Up
142+
- `Ctrl + Shift + F20` - Mute Microphone
143+
- `Ctrl + Shift + Alt + F13` - Toggle Display Refresh Rate
144+
- `Ctrl + Shift + Alt + F14` - Eco GPU Mode
145+
- `Ctrl + Shift + Alt + F15` - Standard GPU Mode
146+
- `Ctrl + Shift + Alt + F16` - Silent
147+
- `Ctrl + Shift + Alt + F17` - Balanced
148+
- `Ctrl + Shift + Alt + F18` - Turbo
149+
- `Ctrl + Shift + Alt + F19` - Custom 1 (if exists)
150+
- `Ctrl + Shift + Alt + F20` - Custom 2 (if exists)
148151
- [Custom keybindings / hotkeys](https://github.com/seerge/g-helper/wiki/Power-user-settings#custom-hotkey-actions)
149152

150153
### 🎮ROG Ally Bindings
151-
- ``M + DPad Left / Right`` - Display Brightness
152-
- ``M + DPad Up`` - Touch keyboard
153-
- ``M + DPad Down`` - Show desktop
154-
- ``M + Y`` - Toggle AMD overay
155-
- ``M + X`` - Screenshot
156-
- ``M + Right Stick Click`` - Controller Mode
157154

158-
------------------
155+
- `M + DPad Left / Right` - Display Brightness
156+
- `M + DPad Up` - Touch keyboard
157+
- `M + DPad Down` - Show desktop
158+
- `M + Y` - Toggle AMD overay
159+
- `M + X` - Screenshot
160+
- `M + Right Stick Click` - Controller Mode
161+
162+
---
159163

160164
### 🔖 Important Notice
161165

162-
G-Helper is **NOT** an operating system, firmware, or driver. It **DOES NOT** "run" your hardware in real-time anyhow.
166+
G-Helper is **NOT** an operating system, firmware, or driver. It **DOES NOT** "run" your hardware in real-time anyhow.
163167

164168
It's an app that lets you select one of the predefined operating modes created by manufacturer (and stored in BIOS) and optionally(!) set some settings that already exist on your device same as Armoury Crate can. It does it by using the Asus System Control Interface "driver" that Armoury uses for it.
165169

@@ -168,13 +172,15 @@ If you use equivalent mode/settings as in Armoury Crate - the performance or the
168172
The role of G-Helper for your laptop is similar to the role of a remote control for your TV.
169173

170174
### Libraries and projects used
175+
171176
- [Linux Kernel](https://github.com/torvalds/linux/blob/master/include/linux/platform_data/x86/asus-wmi.h) for some basic endpoints in ASUS ACPI/WMI interface
172177
- [NvAPIWrapper](https://github.com/falahati/NvAPIWrapper) for accessing Nvidia API
173178
- [Starlight](https://github.com/vddCore/Starlight) for anime matrix communication protocol
174179
- [UXTU](https://github.com/JamesCJ60/Universal-x86-Tuning-Utility) for undervolting using Ryzen System Management Unit
175180
- [AsusCtl](https://gitlab.com/asus-linux/asusctl) for inspiration and some reverse engineering
176181

177182
### Disclaimers
183+
178184
"Asus", "ROG", "TUF", and "Armoury Crate" are trademarked by and belong to AsusTek Computer, Inc. I make no claims to these or any assets belonging to AsusTek Computer and use them purely for informational purposes only.
179185

180186
THE SOFTWARE IS PROVIDED “AS IS” AND WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. MISUSE OF THIS SOFTWARE COULD CAUSE SYSTEM INSTABILITY OR MALFUNCTION.

0 commit comments

Comments
 (0)