Skip to content

Commit bcff33c

Browse files
committed
Below:
* Minor updates to instructions in README.md and GitHub Pages * The compiled binary along with install scripts are now available as a single compressed zip file
1 parent 7af9082 commit bcff33c

File tree

3 files changed

+32
-10
lines changed

3 files changed

+32
-10
lines changed

.github/workflows/go.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,21 @@ jobs:
4747
- name: Make compiled binary available
4848
run: |
4949
echo "Working on making the compiled binary available..."
50-
mkdir public
51-
cp -r ./undervolt-go ./public/ # Copy the binary to the public directory
52-
cp -r ./dist/script/* ./public/ # Copy the install scripts to the public directory
50+
mkdir latest-build staging public
51+
cp -r ./undervolt-go ./latest-build/ # Copy the binary to the latest-build directory
52+
cp -r ./dist/script/* ./latest-build/ # Copy the install scripts to the latest-build directory
5353
echo "Ready to deploy!"
54+
- name: Compress the 'latest-build' under 'staging' directory and make it available in 'public'
55+
run: |
56+
zip -r staging/undervolt-go.zip ./latest-build/ # Make a zip file of the latest build
57+
cp -r staging/undervolt-go.zip ./public/
58+
echo "Compress complete and available in public directory!"
5459
- name: Output the files structure into a JSON file
5560
run: |
5661
# GitHub Actions' ubuntu-latest comes preinstalled with tree. So no need to install tree.
5762
#sudo apt update
5863
#sudo apt install -y tree
59-
tree -J public > ./public/files.json
64+
tree -J staging > ./public/files.json
6065
echo "JSON Manifest generated with the directory structure!"
6166
- name: Make web pages available
6267
run: |

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,16 @@ To build **undervolt-go**, follow these steps:
6161
## Installation
6262

6363
To install **undervolt-go** on your system, follow these steps:
64-
1. Download latest release from GitHub Releases.
65-
2. Extract the archive
66-
3. Simply make install-undervolt.sh executable
64+
1. Download latest release from [offical nightly builds](https://softorage.github.io/undervolt-go/)
65+
2. Extract the archive. You should now have the following files:
66+
1. undervolt-go
67+
2. install-undervolt.sh
68+
3. update-undervolt.sh
69+
3. Simply make install-undervolt.sh executable (or update-undervolt.sh if you already have it):
6770
- `chmod +x install-undervolt.sh`
6871
- or you can right click install-undervolt.sh, go to Properties, and in the Permissions tab, tick 'Make executable'
6972
4. If you have built the binary by yourselves, replace the downloaded undervolt-go with your undervolt-go
70-
5. Run install-undervolt.sh with sudo (it's always recommended to check the script by opening it in a text editor before executing it)
73+
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)
7174
`sudo ./install-undervolt.sh`
7275

7376
## Usage

dist/pages/index.html

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="UTF-8">
5-
<title>Artifact Explorer</title>
5+
<title>undervolt-go Nightly Builds</title>
66
<!-- PicoCSS via CDN -->
77
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@picocss/pico@latest/css/pico.classless.min.css">
88
<style>
@@ -23,7 +23,21 @@
2323
</head>
2424
<body>
2525
<header>
26-
<h1>Artifact Explorer</h1>
26+
<h1>undervolt-go Nightly Builds</h1>
27+
<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>
40+
</p>
2741
</header>
2842
<main>
2943
<!-- Breadcrumb navigation -->

0 commit comments

Comments
 (0)