summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTrainDoctor <11465594+TrainDoctor@users.noreply.github.com>2022-06-14 13:38:29 -0700
committerGitHub <noreply@github.com>2022-06-14 16:38:29 -0400
commitd67d18ab7766e8dbb79fd48ac347d601f82d3332 (patch)
treeb1011506dd692add360f0e5b1a53dc750204a83d /README.md
parent26dc961f583f66b8333d4f4ddbdba51c00676a7e (diff)
downloaddecky-bazzite-buddy-d67d18ab7766e8dbb79fd48ac347d601f82d3332.tar.gz
decky-bazzite-buddy-d67d18ab7766e8dbb79fd48ac347d601f82d3332.zip
Add README, tasks, moved to pnpm and added an ignore for react (#3)
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..04401c8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# React-Frontend Plugin Template
+
+Reference example for using [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) in a [PluginLoader](https://github.com/SteamDeckHomebrew/PluginLoader) plugin.
+
+## PluginLoader Discord [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/ZU74G2NJzk)
+
+## Developers
+
+### Dependencies
+
+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
+```
+
+### Getting Started
+
+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. ``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
+
+WIP. Check back in later.
+