diff --git a/scripts/README.md b/scripts/README.md index 4b60858..09aab99 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,15 +1,20 @@ -# Script overview +# Scripts -Overview and quickstart instructions for scripts. +A collection of scripts for the GPD Win 3. Mostly to minimize the reuqired typing on the keyboard. 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` -For example if the scripts are located in `/home/user/.local/win3-resources/scripts`, add the following at the end of your `~/.bashrc`: + +## Quickstart + +To quickly install the scripts, make sure `git` is installed and run this in a terminal: ``` -PATH="${PATH}:/home/user/.local/win3-resources/scripts" -``` +mkdir -p ~/.local +git clone https://gitea.quad.moe/quad/win3-resources.git ~/.local/gpd-win3 +echo -e "\n# GPD Win 3 scripts\nPATH=\"\${PATH}:\${HOME}/.local/gpd-win3/scripts\"" >> ~/.bashrc +``` -Replacing the folder as needed. +Then restart your terminal. Run `tdp check` if you want to test. ## TDP