Skip to content

Commit f923189

Browse files
committed
Minor docs updates to README.md and index.html
1 parent ffba26a commit f923189

File tree

4 files changed

+36
-17
lines changed

4 files changed

+36
-17
lines changed

.github/workflows/go.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ jobs:
4949
- name: Build Undervolt Go Pro
5050
run: |
5151
echo "Building Undervolt Go Pro..."
52-
go build -tags gui -ldflags="-X main.version=$(git describe --tags)" -o undervolt-go-pro .
52+
go build -tags gui -ldflags="-X 'main.version=$(git describe --tags)'" -o undervolt-go-pro .
5353
echo "Build complete!"
5454
- name: Make compiled binary available
5555
run: |

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,17 +64,18 @@ To build **Undervolt Go**, follow these steps:
6464

6565
To install **Undervolt Go** on your system, follow these steps:
6666
1. Download latest release from [offical nightly builds](https://softorage.github.io/undervolt-go/).
67-
- You can download the GUI version (slightly more in size) or the CLI version.
67+
- You can download the Graphical Interface version (Pro version) or the CLI version.
6868
- The GUI version can also run the CLI commands. The commands need to be passed to `undervolt-go-pro`
6969
2. Extract the archive. You should now have the following files:
7070
1. undervolt-go or undervolt-go-pro
7171
2. install-undervolt.sh
7272
3. uninstall-undervolt.sh
7373
4. update-undervolt.sh
74+
5. icon.png (in case of Pro version)
7475
3. Simply make install-undervolt.sh executable (or update-undervolt.sh if you already have Undervolt Go installed on your system):
7576
- `chmod +x install-undervolt.sh`
7677
- or you can right click install-undervolt.sh, go to Properties, and in the Permissions tab, tick 'Make executable'
77-
4. If you have built the binary by yourselves, replace the downloaded undervolt-go with your undervolt-go
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)
7879
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)
7980
`sudo ./install-undervolt.sh`
8081

dist/pages/index.html

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,37 @@
2525
<header>
2626
<h1>undervolt-go Nightly Builds</h1>
2727
<p>
28-
To install undervolt-go on your system, follow these steps:<br>
29-
1. Download latest release from below.<br>
30-
2. Extract the archive. You should now have the following files:<br>
31-
&nbsp;&nbsp;&nbsp;1. undervolt-go<br>
32-
&nbsp;&nbsp;&nbsp;2. install-undervolt.sh<br>
33-
&nbsp;&nbsp;&nbsp;3. update-undervolt.sh<br>
34-
3. Simply make install-undervolt.sh executable (or update-undervolt.sh if you already have it):<br>
35-
&nbsp;&nbsp;&nbsp;- <code>chmod +x install-undervolt.sh</code><br>
36-
&nbsp;&nbsp;&nbsp;- or you can right click install-undervolt.sh, go to Properties, and in the Permissions tab, tick 'Make executable'<br>
37-
4. If you have built the binary by yourselves, replace the downloaded undervolt-go with your undervolt-go<br>
38-
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)<br>
39-
&nbsp;&nbsp;&nbsp;<code>sudo ./install-undervolt.sh</code>
28+
To install <strong>Undervolt Go</strong> on your system, follow these steps:
4029
</p>
30+
<ol type="1">
31+
<li>Download latest release from below.
32+
<ul>
33+
<li>You can download the Graphical Interface version (Pro version) or the Command Line version.</li>
34+
<li>The GUI version can also run the CLI commands. The commands need to be passed to <code>undervolt-go-pro</code>.</li>
35+
</ul>
36+
</li>
37+
<li>Extract the archive. You should now have the following files:
38+
<ol type="1">
39+
<li>undervolt-go or undervolt-go-pro</li>
40+
<li>install-undervolt.sh</li>
41+
<li>uninstall-undervolt.sh</li>
42+
<li>update-undervolt.sh</li>
43+
<li>icon.png (in case of Pro version)</li>
44+
</ol>
45+
</li>
46+
<li>Simply make install-undervolt.sh executable (or update-undervolt.sh if you already have Undervolt Go installed on your system):
47+
<ul>
48+
<li><code>chmod +x install-undervolt.sh</code></li>
49+
<li>or you can right click install-undervolt.sh, go to Properties, and in the Permissions tab, tick ‘Make executable’</li>
50+
</ul>
51+
</li>
52+
<li>If you have built the binary by yourselves, replace the downloaded undervolt-go with your undervolt-go (or undervolt-go-pro for that matter)</li>
53+
<li>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)
54+
<ul>
55+
<li><code>sudo ./install-undervolt.sh</code></li>
56+
</ul>
57+
</li>
58+
</ol>
4159
</header>
4260
<main>
4361
<div>Current directory:

gui.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ func runGUI() {
171171
buf.WriteString("\nError: " + err.Error())
172172
//if os.Geteuid() != 0 { commenting out to see if notifications work with sudo
173173
a.SendNotification(&fyne.Notification{
174-
Title: "undervolt-go",
174+
Title: "Undervolt Go",
175175
Content: "Error occured when applying settings. Please check 'Output' pane for more information.",
176176
})
177177
//}
@@ -413,7 +413,7 @@ func runGUI() {
413413
// without len(collect()) > 0, clicking on apply without any setting relaunches another window of Undervolt Go
414414
if err := run(collect()...); err == nil && len(collect()) > 0 {
415415
a.SendNotification(&fyne.Notification{
416-
Title: "undervolt-go",
416+
Title: "Undervolt Go",
417417
Content: "Settings applied successfully.",
418418
})
419419
}

0 commit comments

Comments
 (0)