Below:

* Updated README to improve some instructions and add FAQs
* Updated GitHub Actions yml file to store the compiled binary in a 'latest-build' compressed archive

Author: SanmayJoshi

.github/workflows/go.yml

@@ -47,17 +47,17 @@ jobs:
     - name: Make compiled binary available
       run: |
         echo "Working on making the compiled binary available..."
-        mkdir staging public
-        cp -r ./undervolt-go ./staging/ # Copy the binary to the staging directory
-        cp -r ./dist/script/* ./staging/ # Copy the install scripts to the staging directory
+        mkdir latest-build public
+        cp -r ./undervolt-go ./latest-build/ # Copy the binary to the latest-build directory
+        cp -r ./dist/script/* ./latest-build/ # Copy the install scripts to the latest-build directory
         echo "Ready to deploy!"
-    - name: Compress the 'latest-build' under 'staging' directory and make it available in 'public'
+    - name: Compress the 'latest-build' and make it available in 'public'
       run: |
-        zip -r undervolt-go.zip ./staging/ # Make a zip file of the latest build
+        zip -r undervolt-go.zip ./latest-build/ # Make a zip file of the latest build
         cp -r undervolt-go.zip ./public/
         echo "Compress complete and available in public directory!"
-        echo "Removing the now unused staging directory and undervolt-go.zip..."
-        rm -r undervolt-go.zip staging
+        echo "Removing the now unused latest-build directory and undervolt-go.zip..."
+        rm -r undervolt-go.zip latest-build
         echo "Removing complete!"
     - name: Output the files structure into a JSON file
       run: |

README.md

@@ -3,8 +3,7 @@
 **undervolt-go** is a Go port of the original [undervolt](https://github.com/georgewhewell/undervolt) utility, designed to allow users to undervolt Intel CPUs on Linux systems. Undervolting can help reduce CPU temperatures, decrease power consumption, and potentially increase system stability and longevity. **undervolt-go** gives the advantage of running the application without the need for any dependencies.
 
 _**Note:**_
-- *Please use this software with caution. It can damage you computer.*
-- *We may use AI when developing this project.*
+- *Please use this software with extreme caution. It has the potential to damage your computer if used incorrectly.*
 
 ## Table of Contents
 
@@ -17,6 +16,7 @@ _**Note:**_
 - [Configuration](#configuration)
 - [Examples](#examples)
 - [Troubleshooting](#troubleshooting)
+- [FAQ](#faq)
 - [Contributors](#contributors)
 - [License](#license)
 
@@ -63,9 +63,9 @@ To build **undervolt-go**, follow these steps:
 To install **undervolt-go** on your system, follow these steps:
 1. Download latest release from [offical nightly builds](https://softorage.github.io/undervolt-go/)
 2. Extract the archive. You should now have the following files:
-  1. undervolt-go
-  2. install-undervolt.sh
-  3. update-undervolt.sh
+   1. undervolt-go
+   2. install-undervolt.sh
+   3. update-undervolt.sh
 3. Simply make install-undervolt.sh executable (or update-undervolt.sh if you already have it):
    - `chmod +x install-undervolt.sh`
    - or you can right click install-undervolt.sh, go to Properties, and in the Permissions tab, tick 'Make executable'
@@ -80,45 +80,46 @@ To install **undervolt-go** on your system, follow these steps:
 1. To apply a voltage offset, use the following syntax:
 
    ```bash
-   sudo ./undervolt-go --core=-100 --cache=-50 --gpu=-50
+   sudo undervolt-go --core=-100 --cache=-50 --gpu=-50
    ```
 
    This command applies a -100 mV offset to the CPU core, -50 mV to the CPU cache, and a -50 mV offset to the GPU.
 
 2. This command applies a 40W power limit to PL1 and a 32s time window. PL1 is the long term power limit, that can be safe for longer periods.
 
    ```bash
-   sudo ./undervolt-go --p1=40,32
+   sudo undervolt-go --p1=40,32
    ```
 
 3. This command applies a 60W power limit to PL2 and a 32s time window. PL2 is the short term power limit, that can be safe for shorter periods and is useful for short bursts of performance.
 
    ```bash
-   sudo ./undervolt-go --p2=60,32
+   sudo undervolt-go --p2=60,32
    ```
 
 4. All commands can be found in the help menu:
 
    ```bash
-    Usage:
-    undervolt-go [flags]
-
-    Flags:
-        --analogio float     analogio offset (mV) (default NaN)
-        --cache float        cache offset (mV) (default NaN)
-        --core float         core offset (mV) (default NaN)
-        --force              allow setting positive offsets
-        --gpu float          gpu offset (mV) (default NaN)
-    -h, --help               help for undervolt-go
-        --lock-power-limit   lock the power limit
-        --p1 strings         P1 Power Limit (W) and Time Window (s), e.g., --p1=35,10
-        --p2 strings         P2 Power Limit (W) and Time Window (s), e.g., --p2=45,5
-        --read               read existing values
-        --temp int           set temperature target on AC (°C) (default -1)
-        --temp-bat int       set temperature target on battery (°C) (default -1)
-        --turbo int          set Intel Turbo (1 disabled, 0 enabled) (default -1)
-        --uncore float       uncore offset (mV) (default NaN)
-        --verbose            print debug info
+   Usage:
+   undervolt-go [flags]
+
+   Flags:
+         --analogio float     analogio offset (mV) (default NaN)
+         --cache float        cache offset (mV) (default NaN)
+         --core float         core offset (mV) (default NaN)
+         --force              allow setting positive offsets
+         --gpu float          gpu offset (mV) (default NaN)
+   -h, --help               help for undervolt-go
+         --lock-power-limit   lock the power limit
+         --p1 strings         P1 Power Limit (W) and Time Window (s), e.g., --p1=35,10
+         --p2 strings         P2 Power Limit (W) and Time Window (s), e.g., --p2=45,5
+         --read               read existing values
+         --temp int           set temperature target on AC (°C) (default -1)
+         --temp-bat int       set temperature target on battery (°C) (default -1)
+         --turbo int          set Intel Turbo (1 disabled, 0 enabled) (default -1)
+         --uncore float       uncore offset (mV) (default NaN)
+         --verbose            print debug info
+   -v, --version            version for undervolt-go
    ```
 
 ## Features
@@ -149,23 +150,23 @@ To install **undervolt-go** on your system, follow these steps:
 - **Read Current Voltage Offsets:**
 
   ```bash
-  sudo ./undervolt-go --read
+  sudo undervolt-go --read
   ```
 
   This command displays the current voltage offsets applied to the CPU components.
 
 - **Set Temperature Target to 85°C:**
 
   ```bash
-  sudo ./undervolt-go --temp=85
+  sudo undervolt-go --temp=85
   ```
 
   This sets the CPU throttling temperature target to 85 degrees Celsius.
 
 - **Disable Intel Turbo Boost:**
 
   ```bash
-  sudo ./undervolt-go --turbo=1
+  sudo undervolt-go --turbo=1
   ```
 
   This command disables Intel Turbo Boost, potentially reducing heat and power consumption.
@@ -176,6 +177,44 @@ To install **undervolt-go** on your system, follow these steps:
 - **Settings Reset After Reboot:** Voltage offsets are not persistent across reboots by default. Create a startup script to apply your preferred settings automatically.
 - **Permission Denied Errors:** Ensure you are running the commands with `sudo` to have the necessary privileges.
 
+## FAQ
+
+1. Is undervolting safe?
+
+Undervolting can be safe if done correctly, but it carries inherent risks. Applying incorrect voltage settings can lead to system instability, crashes, or hardware damage. Start with small negative voltage offsets, and choose the offset just before the system starts crashing. You may have to manually cut the power when the system crashes due to undervolt.
+
+2. Do I need to install any dependencies to use undervolt-go?
+
+No, undervolt-go is built using Go and does not require any external dependencies. However, to interact with CPU settings, the application needs to run with elevated privileges.
+
+3. How do I use undervolt-go to undervolt my CPU?
+
+To use undervolt-go:
+
+   Mehtod 1: Without installation:
+
+   - Open Terminal: Launch your terminal application.​
+   - Navigate to the Executable Location: Ensure you're in the directory containing the undervolt-go executable (`cd` into the directory where 'undervolt-go' is located) or provide the full path to it.​
+   - Run the Executable: Execute the program with appropriate permissions:​
+      `sudo ./undervolt-go`
+
+   Mehtod 2: With installation:
+
+   - Open Terminal: Launch your terminal application.
+   - Navigate to the undervolt-go directory: Change to the directory containing the undervolt-go executable, along with the install-undervolt.sh and update-undervolt.sh scripts. Make sure that all the files are in the same directory.
+   - Install undervolt-go: Run the install-undervolt.sh script: 
+      `sudo ./install-undervolt.sh`
+   - Run undervolt-go: You can now use 'undervolt-go' from any directory.Run the undervolt-go executable with root privileges:
+      `sudo undervolt-go`
+
+4. Do you use AI to develop this project?
+
+We may use AI when developing this project. If you find any issues, please report them to us. We will try to fix them as soon as possible.
+
+5. Which Intel CPUs are supported by undervolt-go?
+
+undervolt-go supports a range of Intel CPUs, particularly those from the Haswell generation and newer. However, compatibility can vary based on your specific system configuration. 
+
 ## Contributors
 
 We welcome contributions from the community. If you'd like to contribute to **undervolt-go**, please fork the repository and submit a pull request with your changes.