Skip to content

Commit e44141c

Browse files
committed
Below:
* Added screenshots to README.md * Minor doc updates to README.md and index.html
1 parent f923189 commit e44141c

11 files changed

+30
-14
lines changed

README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ _**Note:**_
1414
- [Building](#building)
1515
- [Usage](#usage)
1616
- [Features](#features)
17+
- [Screenshots](#screenshots)
1718
- [Dependencies](#dependencies)
1819
- [Configuration](#configuration)
1920
- [Examples](#examples)
@@ -67,16 +68,17 @@ To install **Undervolt Go** on your system, follow these steps:
6768
- You can download the Graphical Interface version (Pro version) or the CLI version.
6869
- The GUI version can also run the CLI commands. The commands need to be passed to `undervolt-go-pro`
6970
2. Extract the archive. You should now have the following files:
70-
1. undervolt-go or undervolt-go-pro
71-
2. install-undervolt.sh
72-
3. uninstall-undervolt.sh
73-
4. update-undervolt.sh
74-
5. icon.png (in case of Pro version)
75-
3. Simply make install-undervolt.sh executable (or update-undervolt.sh if you already have Undervolt Go installed on your system):
71+
1. `undervolt-go` or `undervolt-go-pro`
72+
2. `install-undervolt.sh`
73+
3. `uninstall-undervolt.sh`
74+
4. `update-undervolt.sh`
75+
5. `icon.png` (in case of Pro version)
76+
3. Open Terminal and navigate to the directory containing the undervolt-go or undervolt-go-pro executable. You can often simply launch Terminal in the active folder with a right-click.
77+
4. Simply make `install-undervolt.sh` executable (or `update-undervolt.sh` if you already have Undervolt Go installed on your system):
7678
- `chmod +x install-undervolt.sh`
77-
- or you can right click install-undervolt.sh, go to Properties, and in the Permissions tab, tick 'Make executable'
78-
4. If you have built the binary by yourselves, replace the downloaded undervolt-go with your undervolt-go (or undervolt-go-pro for that matter)
79-
5. Run install-undervolt.sh (or update-undervolt.sh) with sudo (it's always recommended to check the script by opening it in a text editor before executing it)
79+
- or you can right click `install-undervolt.sh`, go to Properties, and in the Permissions tab, tick 'Make executable'
80+
5. If you have built the binary by yourselves, replace the downloaded undervolt-go with your undervolt-go (or undervolt-go-pro for that matter)
81+
6. Run `install-undervolt.sh` (or `update-undervolt.sh`) with sudo (it's always recommended to check the script by opening it in a text editor before executing it)
8082
`sudo ./install-undervolt.sh`
8183

8284
## Usage
@@ -144,6 +146,19 @@ To install **Undervolt Go** on your system, follow these steps:
144146
- **Temperature Monitoring:** Monitor and display the current temperature of the CPU.
145147
- **Fan Monitoring:** Monitor and display the current fan speed of the CPU.
146148

149+
## Screenshots
150+
| Description | Screenshot |
151+
| --- | --- |
152+
| Voltage Offsets | ![Voltage Offsets](/dist/images/screenshots/v0.5.4/VoltOffset-UndervoltGo.png) |
153+
| Power Limit | ![Power Limit](/dist/images/screenshots/v0.5.4/PowerLimit-UndervoltGo.png) |
154+
| Temperature Limit | ![Temperature Limit](/dist/images/screenshots/v0.5.4/TempLimit-UndervoltGo.png) |
155+
| Other Flags | ![Other Flags](/dist/images/screenshots/v0.5.4/OtherFlags-UndervoltGo.png) |
156+
| Output | ![Output](/dist/images/screenshots/v0.5.4/Output-UndervoltGo.png) |
157+
| Check Core Temps | ![Check Core Temps](/dist/images/screenshots/v0.5.4/CheckTemp-UndervoltGo.png) |
158+
| Check Fan RPMs | ![Check Fan RPMs](/dist/images/screenshots/v0.5.4/CheckFans-UndervoltGo.png) |
159+
| Read | ![Read](/dist/images/screenshots/v0.5.4/Read-UndervoltGo.png) |
160+
| Version | ![Version](/dist/images/screenshots/v0.5.4/Ver-UndervoltGo.png) |
161+
147162
## Dependencies
148163

149164
- **For usage**
@@ -225,9 +240,9 @@ To edit `sudoers` file,
225240
226241
Mehtod 2: With installation:
227242
228-
- Navigate to the undervolt-go or undervolt-go-pro directory: Change to the directory containing the undervolt-go executable or undervolt-go-pro executable for graphical version, along with the install-undervolt.sh, uninstall-undervolt.sh and update-undervolt.sh scripts. Make sure that all the files are in the same directory.
243+
- Navigate to the undervolt-go or undervolt-go-pro directory: Change to the directory containing the undervolt-go executable or undervolt-go-pro executable for graphical version, along with the `install-undervolt.sh`, `uninstall-undervolt.sh` and `update-undervolt.sh` scripts. Make sure that all the files are in the same directory.
229244
- Open Terminal: Launch your terminal application in the undervolt-go or undervolt-go-pro directory.
230-
- Install Undervolt Go: Run the install-undervolt.sh script:
245+
- Install Undervolt Go: Run the `install-undervolt.sh` script:
231246
`sudo ./install-undervolt.sh`
232247
- Run Undervolt Go:
233248
- For `undervolt-go`, you can now use 'Undervolt Go' from any directory. Run the `undervolt-go` command with root privileges:
48.4 KB
Loading
90.8 KB
Loading
48.7 KB
Loading
48 KB
Loading
48.9 KB
Loading
84.7 KB
Loading
42 KB
Loading
47.2 KB
Loading
53.5 KB
Loading

0 commit comments

Comments
 (0)