From c15ae3b7438ba880f3acc3774d4e5e41eba4c436 Mon Sep 17 00:00:00 2001 From: TrainDoctor Date: Wed, 10 Aug 2022 13:33:24 -0700 Subject: [PATCH] Big README update and comments in Dockerfile --- README.md | 9 +++------ backend/Dockerfile | 10 +++++++--- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1631769..9453eda 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # React-Frontend Plugin Template [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/ZU74G2NJzk) -Reference example for using [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) in a [decky-loader](https://github.com/SteamDeckHomebrew/decky-loader) plugin. + +Reference example for using [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) in a [decky-loader](https://github.com/SteamDeckHomebrew/deckly-loader) plugin. If you want to get in contact with the developers, we can be found in the **[SteamDeckHomebrew Discord](https://discord.gg/ZU74G2NJzk)**. @@ -63,8 +64,7 @@ More information on the bin folder can be found below in the distribution sectio ### Distribution We recommend following the instructions found in the [decky-plugin-database](https://github.com/SteamDeckHomebrew/decky-plugin-database) on how to get your plugin up on the plugin store. This is the best way to get your plugin in front of users. -You can also choose to do distribution via a zip file containing the needed files, if that zip file is uploaded to a URL it can then be downloded and installed via decky-loader. -Please note that decky-loader will be warn them that the plugin is not verified via hash as it would be coming from the plugin store. +You can also choose to do distribution via a zip file containing the needed files, if that zip file is uploaded to a URL it can then be downloded and installed via decky-loader. **NOTE: We do not currently have a method to install from a downloaded zip file in "game-mode" due to lack of a usable file-picking dialog.** @@ -91,7 +91,4 @@ pluginname-v1.0.0.zip (version number is optional but recommended for users sake Note regarding licenses: Including a license is required for the plugin store if your chosen license requires the license to be included alongside usage of source-code/binaries! -If you wish to distribute your plugin another way then you will need to build and bundle the plugin as a zip file. - - We cannot and will not distribute your plugin on the Plugin Store if it's license requires it's inclusion but you have not included a license to be re-distributed with your plugin in the root of your git repository. diff --git a/backend/Dockerfile b/backend/Dockerfile index 3732252..f46e170 100644 --- a/backend/Dockerfile +++ b/backend/Dockerfile @@ -1,5 +1,9 @@ +# we support images for building with a vanilla SteamOS base, +# or versions with ootb support for rust or go +# developers can also customize these images via this Dockerfile +#FROM ghcr.io/steamdeckhomebrew/holo-toolchain-rust:latest +#FROM ghcr.io/steamdeckhomebrew/holo-toolchain-go:latest FROM ghcr.io/steamdeckhomebrew/holo-base:latest -ENTRYPOINT [ "/source/entrypoint.sh" ] - -WORKDIR /src \ No newline at end of file +# entrypoint.sh should always be located in the backend folder +ENTRYPOINT [ "/backend/entrypoint.sh" ] \ No newline at end of file