From eb3ee43b50ad9493ca370fbb9510c41df824e158 Mon Sep 17 00:00:00 2001 From: TrainDoctor <11465594+TrainDoctor@users.noreply.github.com> Date: Tue, 14 Jun 2022 13:26:23 -0700 Subject: [PATCH] Change to "Getting Started" and moved lib --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 48d3985..04401c8 100644 --- a/README.md +++ b/README.md @@ -12,18 +12,24 @@ This template relies on the user having `pnpm` installed on their system. This can be downloaded from `npm` itself which is recommended. #### Linux + ```bash sudo npm i -g pnpm ``` -### Keep Your Plugin Updated +### Getting Started -1. In your plugin's repository run these commands: +1. Clone the repository to use as an example for making your plugin. +2. In your clone of the repository run these commands: 1. ``pnpm i`` - 2. (Optional, needed to solve build errors) - 1. ``pnpm update decky-frontend-lib --latest`` - 3. ``pnpm run build`` -2. You should perform numbers 1 and 3 every time you make changes to your plugin. + 2. ``pnpm run build`` +3. You should do this every time you make changes to your plugin. + +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 +``` ### Distribution