diff options
| author | TrainDoctor <traindoctor@protonmail.com> | 2022-07-25 17:08:10 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-25 17:08:10 -0700 |
| commit | b929b2dddf6ae0e6237582e1df7d794ee4212f06 (patch) | |
| tree | 7fe0eec35061cac379f24b20d96563bf195a33bb /README.md | |
| parent | fb0b70343812aae78576e3645ad77d0d927a3f95 (diff) | |
| download | decky-loader-b929b2dddf6ae0e6237582e1df7d794ee4212f06.tar.gz decky-loader-b929b2dddf6ae0e6237582e1df7d794ee4212f06.zip | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -46,6 +46,22 @@ Keep an eye on the [Wiki](https://deckbrew.xyz) for more information about Plugi - [Here's how to get the Steam Deck UI on your enviroment of choice.](https://youtu.be/1IAbZte8e7E?t=112) - (The video shows Windows usage but unless you're using Arch WSL/cygwin this script is unsupported on Windows.) +### Getting Started + +1. Clone the repository using the latest commit to main before staring your PR. +2. In your clone of the repository run these commands: + 1. ``pnpm i`` + 2. ``pnpm run build`` +3. If you are modifying the UI, these will need to be run before deploying the changes to your Deck. +4. Use the vscode tasks or ``deck.sh`` script to deploy your changes to your Deck to test them. +5. You will be testing your changes with the python script version, so you will need to build, deploy and reload each time. + +Note: If you are recieveing build errors due to an out of date library, you should run this command inside of your repository: + +```bash +pnpm update decky-frontend-lib --latest +``` + Source control and deploying plugins are left to each respective contributor for the cloned repos in order to keep depedencies up to date. ## Credit |
