From 89ac8e5ee0a27adcc741c87078bb1c7930645c1d Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Thu, 11 Feb 2021 08:47:30 +1100 Subject: [PATCH] add port plugins documentation --- .../Default Icons/app_missing_img.png | Bin .../Default Icons/app_missing_img_01.png | Bin .../Default Icons/app_missing_img_01.svg | 0 .../Default Icons/app_missing_img_02.png | Bin .../Default Icons/app_missing_img_02.svg | 0 .../Default Icons/app_missing_img_03.png | Bin .../Default Icons/app_missing_img_03.svg | 0 .../Default Icons/app_missing_img_buttons.png | Bin .../Default Icons/app_missing_img_buttons.svg | 0 .../Default Icons/app_missing_img_fluent.png | Bin .../Default Icons/app_missing_img_fluent.svg | 0 .../Default Icons/app_missing_img_huge.png | Bin .../Default Icons/app_missing_img_huge.svg | 0 .../app_missing_img_lightblue.png | Bin .../app_missing_img_lightblue.svg | 0 .../app_missing_img_lightblue_buttons.png | Bin .../app_missing_img_lightblue_buttons.svg | 0 .../Default Icons/app_missing_img_minimal.png | Bin .../Default Icons/app_missing_img_minimal.svg | 0 .../app_missing_img_minimal_buttons.png | Bin .../app_missing_img_minimal_buttons.svg | 0 {Doc => Artworks}/Logo/app_error.png | Bin {Doc => Artworks}/Logo/logo.ico | Bin {Doc => Artworks}/Logo/logo.png | Bin {Doc => Artworks}/Logo/logo.svg | 0 {Doc => Artworks}/Logo/logo128.png | Bin {Doc => Artworks}/Logo/logo16.png | Bin {Doc => Artworks}/Logo/logo256.png | Bin {Doc => Artworks}/Logo/logo32.png | Bin {Doc => Artworks}/Logo/logo48.png | Bin {Doc => Artworks}/Logo/logo512.png | Bin {Doc => Artworks}/Logo/logo64.png | Bin .../flow-header-landscape-transparent.png | Bin .../Logo/resources/flow-header-landscape.png | Bin .../flow-header-square-transparent.png | Bin .../Logo/resources/flow-header-square.png | Bin {Doc => Artworks}/Logo/resources/flow-logo.ai | 0 {Doc => Artworks}/Logo/resources/preview.pdf | Bin {Doc => Artworks}/app.ico | Bin {Doc => Artworks}/app.png | Bin {Doc => Artworks}/app_error.png | Bin {Doc => Artworks}/app_missing_img.png | Bin {Doc => Artworks}/mainsearch.png | Bin Docs/port-plugins.md | 17 +++++++++++++++++ 44 files changed, 17 insertions(+) rename {Doc => Artworks}/Default Icons/app_missing_img.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_01.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_01.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_02.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_02.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_03.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_03.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_buttons.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_buttons.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_fluent.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_fluent.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_huge.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_huge.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_lightblue.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_lightblue.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_lightblue_buttons.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_lightblue_buttons.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_minimal.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_minimal.svg (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_minimal_buttons.png (100%) rename {Doc => Artworks}/Default Icons/app_missing_img_minimal_buttons.svg (100%) rename {Doc => Artworks}/Logo/app_error.png (100%) rename {Doc => Artworks}/Logo/logo.ico (100%) rename {Doc => Artworks}/Logo/logo.png (100%) rename {Doc => Artworks}/Logo/logo.svg (100%) rename {Doc => Artworks}/Logo/logo128.png (100%) rename {Doc => Artworks}/Logo/logo16.png (100%) rename {Doc => Artworks}/Logo/logo256.png (100%) rename {Doc => Artworks}/Logo/logo32.png (100%) rename {Doc => Artworks}/Logo/logo48.png (100%) rename {Doc => Artworks}/Logo/logo512.png (100%) rename {Doc => Artworks}/Logo/logo64.png (100%) rename {Doc => Artworks}/Logo/resources/flow-header-landscape-transparent.png (100%) rename {Doc => Artworks}/Logo/resources/flow-header-landscape.png (100%) rename {Doc => Artworks}/Logo/resources/flow-header-square-transparent.png (100%) rename {Doc => Artworks}/Logo/resources/flow-header-square.png (100%) rename {Doc => Artworks}/Logo/resources/flow-logo.ai (100%) rename {Doc => Artworks}/Logo/resources/preview.pdf (100%) rename {Doc => Artworks}/app.ico (100%) rename {Doc => Artworks}/app.png (100%) rename {Doc => Artworks}/app_error.png (100%) rename {Doc => Artworks}/app_missing_img.png (100%) rename {Doc => Artworks}/mainsearch.png (100%) create mode 100644 Docs/port-plugins.md diff --git a/Doc/Default Icons/app_missing_img.png b/Artworks/Default Icons/app_missing_img.png similarity index 100% rename from Doc/Default Icons/app_missing_img.png rename to Artworks/Default Icons/app_missing_img.png diff --git a/Doc/Default Icons/app_missing_img_01.png b/Artworks/Default Icons/app_missing_img_01.png similarity index 100% rename from Doc/Default Icons/app_missing_img_01.png rename to Artworks/Default Icons/app_missing_img_01.png diff --git a/Doc/Default Icons/app_missing_img_01.svg b/Artworks/Default Icons/app_missing_img_01.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_01.svg rename to Artworks/Default Icons/app_missing_img_01.svg diff --git a/Doc/Default Icons/app_missing_img_02.png b/Artworks/Default Icons/app_missing_img_02.png similarity index 100% rename from Doc/Default Icons/app_missing_img_02.png rename to Artworks/Default Icons/app_missing_img_02.png diff --git a/Doc/Default Icons/app_missing_img_02.svg b/Artworks/Default Icons/app_missing_img_02.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_02.svg rename to Artworks/Default Icons/app_missing_img_02.svg diff --git a/Doc/Default Icons/app_missing_img_03.png b/Artworks/Default Icons/app_missing_img_03.png similarity index 100% rename from Doc/Default Icons/app_missing_img_03.png rename to Artworks/Default Icons/app_missing_img_03.png diff --git a/Doc/Default Icons/app_missing_img_03.svg b/Artworks/Default Icons/app_missing_img_03.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_03.svg rename to Artworks/Default Icons/app_missing_img_03.svg diff --git a/Doc/Default Icons/app_missing_img_buttons.png b/Artworks/Default Icons/app_missing_img_buttons.png similarity index 100% rename from Doc/Default Icons/app_missing_img_buttons.png rename to Artworks/Default Icons/app_missing_img_buttons.png diff --git a/Doc/Default Icons/app_missing_img_buttons.svg b/Artworks/Default Icons/app_missing_img_buttons.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_buttons.svg rename to Artworks/Default Icons/app_missing_img_buttons.svg diff --git a/Doc/Default Icons/app_missing_img_fluent.png b/Artworks/Default Icons/app_missing_img_fluent.png similarity index 100% rename from Doc/Default Icons/app_missing_img_fluent.png rename to Artworks/Default Icons/app_missing_img_fluent.png diff --git a/Doc/Default Icons/app_missing_img_fluent.svg b/Artworks/Default Icons/app_missing_img_fluent.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_fluent.svg rename to Artworks/Default Icons/app_missing_img_fluent.svg diff --git a/Doc/Default Icons/app_missing_img_huge.png b/Artworks/Default Icons/app_missing_img_huge.png similarity index 100% rename from Doc/Default Icons/app_missing_img_huge.png rename to Artworks/Default Icons/app_missing_img_huge.png diff --git a/Doc/Default Icons/app_missing_img_huge.svg b/Artworks/Default Icons/app_missing_img_huge.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_huge.svg rename to Artworks/Default Icons/app_missing_img_huge.svg diff --git a/Doc/Default Icons/app_missing_img_lightblue.png b/Artworks/Default Icons/app_missing_img_lightblue.png similarity index 100% rename from Doc/Default Icons/app_missing_img_lightblue.png rename to Artworks/Default Icons/app_missing_img_lightblue.png diff --git a/Doc/Default Icons/app_missing_img_lightblue.svg b/Artworks/Default Icons/app_missing_img_lightblue.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_lightblue.svg rename to Artworks/Default Icons/app_missing_img_lightblue.svg diff --git a/Doc/Default Icons/app_missing_img_lightblue_buttons.png b/Artworks/Default Icons/app_missing_img_lightblue_buttons.png similarity index 100% rename from Doc/Default Icons/app_missing_img_lightblue_buttons.png rename to Artworks/Default Icons/app_missing_img_lightblue_buttons.png diff --git a/Doc/Default Icons/app_missing_img_lightblue_buttons.svg b/Artworks/Default Icons/app_missing_img_lightblue_buttons.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_lightblue_buttons.svg rename to Artworks/Default Icons/app_missing_img_lightblue_buttons.svg diff --git a/Doc/Default Icons/app_missing_img_minimal.png b/Artworks/Default Icons/app_missing_img_minimal.png similarity index 100% rename from Doc/Default Icons/app_missing_img_minimal.png rename to Artworks/Default Icons/app_missing_img_minimal.png diff --git a/Doc/Default Icons/app_missing_img_minimal.svg b/Artworks/Default Icons/app_missing_img_minimal.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_minimal.svg rename to Artworks/Default Icons/app_missing_img_minimal.svg diff --git a/Doc/Default Icons/app_missing_img_minimal_buttons.png b/Artworks/Default Icons/app_missing_img_minimal_buttons.png similarity index 100% rename from Doc/Default Icons/app_missing_img_minimal_buttons.png rename to Artworks/Default Icons/app_missing_img_minimal_buttons.png diff --git a/Doc/Default Icons/app_missing_img_minimal_buttons.svg b/Artworks/Default Icons/app_missing_img_minimal_buttons.svg similarity index 100% rename from Doc/Default Icons/app_missing_img_minimal_buttons.svg rename to Artworks/Default Icons/app_missing_img_minimal_buttons.svg diff --git a/Doc/Logo/app_error.png b/Artworks/Logo/app_error.png similarity index 100% rename from Doc/Logo/app_error.png rename to Artworks/Logo/app_error.png diff --git a/Doc/Logo/logo.ico b/Artworks/Logo/logo.ico similarity index 100% rename from Doc/Logo/logo.ico rename to Artworks/Logo/logo.ico diff --git a/Doc/Logo/logo.png b/Artworks/Logo/logo.png similarity index 100% rename from Doc/Logo/logo.png rename to Artworks/Logo/logo.png diff --git a/Doc/Logo/logo.svg b/Artworks/Logo/logo.svg similarity index 100% rename from Doc/Logo/logo.svg rename to Artworks/Logo/logo.svg diff --git a/Doc/Logo/logo128.png b/Artworks/Logo/logo128.png similarity index 100% rename from Doc/Logo/logo128.png rename to Artworks/Logo/logo128.png diff --git a/Doc/Logo/logo16.png b/Artworks/Logo/logo16.png similarity index 100% rename from Doc/Logo/logo16.png rename to Artworks/Logo/logo16.png diff --git a/Doc/Logo/logo256.png b/Artworks/Logo/logo256.png similarity index 100% rename from Doc/Logo/logo256.png rename to Artworks/Logo/logo256.png diff --git a/Doc/Logo/logo32.png b/Artworks/Logo/logo32.png similarity index 100% rename from Doc/Logo/logo32.png rename to Artworks/Logo/logo32.png diff --git a/Doc/Logo/logo48.png b/Artworks/Logo/logo48.png similarity index 100% rename from Doc/Logo/logo48.png rename to Artworks/Logo/logo48.png diff --git a/Doc/Logo/logo512.png b/Artworks/Logo/logo512.png similarity index 100% rename from Doc/Logo/logo512.png rename to Artworks/Logo/logo512.png diff --git a/Doc/Logo/logo64.png b/Artworks/Logo/logo64.png similarity index 100% rename from Doc/Logo/logo64.png rename to Artworks/Logo/logo64.png diff --git a/Doc/Logo/resources/flow-header-landscape-transparent.png b/Artworks/Logo/resources/flow-header-landscape-transparent.png similarity index 100% rename from Doc/Logo/resources/flow-header-landscape-transparent.png rename to Artworks/Logo/resources/flow-header-landscape-transparent.png diff --git a/Doc/Logo/resources/flow-header-landscape.png b/Artworks/Logo/resources/flow-header-landscape.png similarity index 100% rename from Doc/Logo/resources/flow-header-landscape.png rename to Artworks/Logo/resources/flow-header-landscape.png diff --git a/Doc/Logo/resources/flow-header-square-transparent.png b/Artworks/Logo/resources/flow-header-square-transparent.png similarity index 100% rename from Doc/Logo/resources/flow-header-square-transparent.png rename to Artworks/Logo/resources/flow-header-square-transparent.png diff --git a/Doc/Logo/resources/flow-header-square.png b/Artworks/Logo/resources/flow-header-square.png similarity index 100% rename from Doc/Logo/resources/flow-header-square.png rename to Artworks/Logo/resources/flow-header-square.png diff --git a/Doc/Logo/resources/flow-logo.ai b/Artworks/Logo/resources/flow-logo.ai similarity index 100% rename from Doc/Logo/resources/flow-logo.ai rename to Artworks/Logo/resources/flow-logo.ai diff --git a/Doc/Logo/resources/preview.pdf b/Artworks/Logo/resources/preview.pdf similarity index 100% rename from Doc/Logo/resources/preview.pdf rename to Artworks/Logo/resources/preview.pdf diff --git a/Doc/app.ico b/Artworks/app.ico similarity index 100% rename from Doc/app.ico rename to Artworks/app.ico diff --git a/Doc/app.png b/Artworks/app.png similarity index 100% rename from Doc/app.png rename to Artworks/app.png diff --git a/Doc/app_error.png b/Artworks/app_error.png similarity index 100% rename from Doc/app_error.png rename to Artworks/app_error.png diff --git a/Doc/app_missing_img.png b/Artworks/app_missing_img.png similarity index 100% rename from Doc/app_missing_img.png rename to Artworks/app_missing_img.png diff --git a/Doc/mainsearch.png b/Artworks/mainsearch.png similarity index 100% rename from Doc/mainsearch.png rename to Artworks/mainsearch.png diff --git a/Docs/port-plugins.md b/Docs/port-plugins.md new file mode 100644 index 00000000000..d1283012413 --- /dev/null +++ b/Docs/port-plugins.md @@ -0,0 +1,17 @@ +# Porting Wox Plugins + +Note: +- When porting, please keep the author's commit history +- Flow Launcher targets .Net Core 3.1, so plugins should also be upgraded to keep the continuity of future developments + +Steps: +1. to start off, you can fork/create a new repo, either way the project's commit history must be kept. If it's forked, you can just start updating it. If it's a new repo, do this by first cloning the repo, then add your new repo as a new repo remote, remove the original remote and then push to it. +2. use try convert tool from https://github.com/dotnet/try-convert +3. try-convert -w path-to-folder-or-solution-or-project +4. May need to fix on the project file, a good template to follow is the [Explorer plugin](https://github.com/Flow-Launcher/Flow.Launcher/blob/dev/Plugins/Flow.Launcher.Plugin.Explorer/Flow.Launcher.Plugin.Explorer.csproj) project: + - fix to netcoreapp3.1 + - set the output location as 'Output\Release\' + - add true and false + - bump version to 2.0.0 and fix up any missing attributes if neccessary +5. update code and fix plugin's setting layout if neccessary +6. update readme to indicate where this port is from and the original author of the project \ No newline at end of file