Add install and build instructions

This commit is contained in:
NGnius (Graham) 2022-09-06 17:29:42 -04:00
parent 86471990bb
commit a82f4b6ff6

View file

@ -16,6 +16,13 @@ You will need that installed for this plugin to work.
- Display supplementary battery info - Display supplementary battery info
- Keep settings between restarts (stored in `~/.config/powertools/<appid>.json`) - Keep settings between restarts (stored in `~/.config/powertools/<appid>.json`)
## Build
0. Requirements: a functioning Rust toolchain for x86_64-unknown-linux-musl, npm, and some tech literacy
1. In a terminal, navigate to the backend directory of this project and run `./build.sh`
2. In the root of this project, run `npm run build`
3. Transfer the project (especially dist/ and bin/) to a folder in your Steam Deck's homebrew plugins directory
## License ## License
This is licensed under GNU GPLv3. This is licensed under GNU GPLv3.