diff --git a/scripts/README.md b/scripts/README.md index 85f7639..e06a7ff 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -5,7 +5,7 @@ A collection of scripts for the GPD Win 3. Mostly to minimize the reuqired typin To install scripts, copy them somewhere on your Win 3, then add them to your path. This is done by adding a line to the end of `~/.bashrc` I recommend cloning the repo as `~/.local/gpd-win3` for all the scripts to work properly. -### Quick install +## Quick install To quickly install the scripts, paste this block into a terminal on your GPD Win 3: @@ -34,7 +34,7 @@ gpd-script-update The TDP manager has a GUI. This can be added to your application menu by running the following command: -``` +```bash tdp-gui-install ``` @@ -46,6 +46,22 @@ You might have to log out and back in before the TDP Manager appears in your app - Ensure the scripts folder is in your PATH - (Optional) add `tdp check` to your .bashrc, which will display TDP every time you open a terminal +## Uninstall + +If you wish to uninstall the scripts follow the instructions in this block: + +```bash +# Edit your .bashrc and remove the GPD-related entries at the bottom +nano ~/.bashrc +# Delete the repository +rm -rf ~/.local/gpd-win3 +# Delete the application shortcut for the TDP manager (If installed) +rm -rf ~/.local/share/applications/tdp-gui.desktop +# Delete the systemd service (If installed) +sudo systemctl disable --now tdp-set.service +sudo rm -rf /etc/systemd/system/tdp-set.service +``` + ## TDP Lets you easily set the TDP via the `intel_rapl` driver.