From 1da58769e0b4cc5169fa6326c21239396020197a Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Mon, 28 Jun 2021 12:28:48 +1000 Subject: [PATCH 01/10] Update README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed85d7616bf..18680c2da4c 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,21 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be Remember to star it, flow will love you more :) +--- + +

+ Features • + Getting Started • + Plugins • + Status • + Contributing • + Question/Suggestion • + Developing/Debugging • + Documentation +

+ +--- + ## Features ![The Flow](https://user-images.githubusercontent.com/26427004/82151677-fa9c7100-989f-11ea-9143-81de60aaf07d.gif) @@ -33,7 +48,9 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be [ **SOFTPEDIA EDITOR'S PICK**](https://www.softpedia.com/get/System/Launchers-Shutdown-Tools/Flow-Launcher.shtml) -## Running Flow Launcher +## Getting Started + +### Installation | [Windows 7 and up installer](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) | `WinGet install "Flow Launcher"` | | -------------------------------------------------------------------------------------------- | -------------------------------- | From db70a09e90182b45f58d2e374e4ee0bbdc3e36ca Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Mon, 28 Jun 2021 12:32:29 +1000 Subject: [PATCH 02/10] fix links --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 18680c2da4c..6a9ebc0f1e6 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,14 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be ---

- Features • - Getting Started • - Plugins • - Status • - Contributing • - Question/Suggestion • - Developing/Debugging • - Documentation + Features • + Getting Started • + Plugins • + Status • + Contributing • + Question/Suggestion • + Developing/Debugging • + Documentation

--- From 46d8508646c46262372795d675528d8c33c43502 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Mon, 28 Jun 2021 12:36:25 +1000 Subject: [PATCH 03/10] remove slashes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a9ebc0f1e6..a790ae59779 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,8 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be Plugins • Status • Contributing • - Question/Suggestion • - Developing/Debugging • + Question/Suggestion • + Developing/Debugging • Documentation From 8786b402c6d4e81ea91f2cfabd163289e20dae78 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Tue, 29 Jun 2021 13:36:39 +1000 Subject: [PATCH 04/10] update python section readme --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index a790ae59779..f61c22ff0b1 100644 --- a/README.md +++ b/README.md @@ -71,9 +71,7 @@ Windows may complain about security due to code not being signed, this will be c ### Integrations - If you use Python plugins: - - Install [Python3](https://www.python.org/downloads/), download `.exe` installer. - - Add Python to `%PATH%` or set it in flow's settings. - - Use `pip` to install `flowlauncher`, open cmd and type `pip install flowlauncher`. + - Once a Python plugin has been detected at start up, you will be prompted to either select the location or allow Python (Embeddable) to automatic download for use. - The Python plugin may require additional modules to be installed, please ensure you check by visiting the plugin's website via `pm install` + plugin name, go to context menu and select `Open website`. - Start to launch your Python plugins. - Flow searches files and contents via Windows Index Search, to use Everything: `pm install everything`. From d015a1ec21f376d5bd99ac62965af05c919b6025 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Thu, 1 Jul 2021 08:06:12 +1000 Subject: [PATCH 05/10] update links in readme --- README.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f61c22ff0b1..8c67a7db93d 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be Contributing • Question/Suggestion • Developing/Debugging • - Documentation + Documentation --- @@ -69,16 +69,15 @@ Windows may complain about security due to code not being signed, this will be c [More tips](https://flow-launcher.github.io/docs/#/usage-tips) -### Integrations - - If you use Python plugins: - - Once a Python plugin has been detected at start up, you will be prompted to either select the location or allow Python (Embeddable) to automatic download for use. - - The Python plugin may require additional modules to be installed, please ensure you check by visiting the plugin's website via `pm install` + plugin name, go to context menu and select `Open website`. - - Start to launch your Python plugins. - - Flow searches files and contents via Windows Index Search, to use Everything: `pm install everything`. - ## Plugins -There is a [list of actively maintained plugins](https://github.com/Flow-Launcher/docs/blob/main/plugins.md) in the documentation section, some of which are integrated from other launchers. +Flow searches files and contents via Windows Index Search, to use **Everything**: `pm install everything`. + +If you are using Python plugins, Flow will prompt to either select the location or allow Python (Embeddable) to be automatic downloaded for use. + +Vist [here](https://flow-launcher.github.io/docs/#/plugins) for our plugin portfolio. + +If you are keen to write your own plugin in flow, please take a look at our plugin development documentation ## Status @@ -86,15 +85,15 @@ Flow is under heavy development, but the code base is stable, so contributions a ## Contributing -We welcome all contributions. If you are unsure of a change you want to make, simply put an issue in for discussion, otherwise feel free to put in a pull request. +We welcome all contributions. If you are unsure of a change you want to make, let us know in the [Discussions](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/ideas), otherwise feel free to put in a pull request. -You will find the main goals of flow placed under Projects board, so feel free to contribute on that. If you would like to make small incremental changes, feel free to do so as well. +You will find the main goals of flow placed under [Projects board](https://github.com/Flow-Launcher/Flow.Launcher/projects), so feel free to contribute on that. If you would like to make small incremental changes, feel free to do so as well. Get in touch if you like to join the Flow-Launcher Team and help build this great tool. ## Question/Suggestion -Yes please, submit an issue to let us know. +Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/q-a) section. **Join our community on [Discord](https://discord.gg/AvgAQgh)!** @@ -105,7 +104,3 @@ Flow Launcher's target framework is .Net 5 Install Visual Studio 2019 Install .Net 5 SDK via Visual Studio installer or manually from [here](https://dotnet.microsoft.com/download/dotnet/thank-you/sdk-5.0.103-windows-x64-installer) - -## Documentation - -Visit [here](https://flow-launcher.github.io/docs) for more information on usage, development and design documentations From 6289541e38df100d1d4f01dd0c4d9675037a4125 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sat, 3 Jul 2021 19:07:08 +1000 Subject: [PATCH 06/10] move Plugin section to under Getting Started, update plugin development links --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8c67a7db93d..ad6c04f1d47 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,6 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be

Features • Getting Started • - Plugins • Status • Contributing • Question/Suggestion • @@ -69,7 +68,7 @@ Windows may complain about security due to code not being signed, this will be c [More tips](https://flow-launcher.github.io/docs/#/usage-tips) -## Plugins +### Plugins Flow searches files and contents via Windows Index Search, to use **Everything**: `pm install everything`. @@ -77,7 +76,7 @@ If you are using Python plugins, Flow will prompt to either select the location Vist [here](https://flow-launcher.github.io/docs/#/plugins) for our plugin portfolio. -If you are keen to write your own plugin in flow, please take a look at our plugin development documentation +If you are keen to write your own plugin for flow, please take a look at our plugin development documentation for [C#](https://flow-launcher.github.io/docs/#/develop-csharp-plugins) or [Python](https://flow-launcher.github.io/docs/#/develop-py-plugins) ## Status From 69aed3779a23047a82b66c1363918d2968c3f23a Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sat, 3 Jul 2021 19:17:39 +1000 Subject: [PATCH 07/10] consolidate sections --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ad6c04f1d47..ee71127aa85 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,8 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be

Features • Getting Started • - Status • - Contributing • Question/Suggestion • - Developing/Debugging • + Development • Documentation

@@ -78,25 +76,27 @@ Vist [here](https://flow-launcher.github.io/docs/#/plugins) for our plugin portf If you are keen to write your own plugin for flow, please take a look at our plugin development documentation for [C#](https://flow-launcher.github.io/docs/#/develop-csharp-plugins) or [Python](https://flow-launcher.github.io/docs/#/develop-py-plugins) -## Status +## Question/Suggestion -Flow is under heavy development, but the code base is stable, so contributions are very welcome. If you would like to help maintain it, please do not hesistate to get in touch. +Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/q-a) section. -## Contributing +**Join our community on [Discord](https://discord.gg/AvgAQgh)!** -We welcome all contributions. If you are unsure of a change you want to make, let us know in the [Discussions](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/ideas), otherwise feel free to put in a pull request. +## Development -You will find the main goals of flow placed under [Projects board](https://github.com/Flow-Launcher/Flow.Launcher/projects), so feel free to contribute on that. If you would like to make small incremental changes, feel free to do so as well. +### Status -Get in touch if you like to join the Flow-Launcher Team and help build this great tool. +Flow is under heavy development, but the code base is stable, so contributions are very welcome. If you would like to help maintain it, please do not hesistate to get in touch. -## Question/Suggestion +### Contributing -Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/q-a) section. +We welcome all contributions. If you are unsure of a change you want to make, let us know in the [Discussions](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/ideas), otherwise feel free to put in a pull request. -**Join our community on [Discord](https://discord.gg/AvgAQgh)!** +You will find the main goals of flow placed under the [Projects board](https://github.com/Flow-Launcher/Flow.Launcher/projects), so feel free to contribute on that. If you would like to make small incremental changes, feel free to do so as well. + +Get in touch if you like to join the Flow-Launcher Team and help build this great tool. -## Developing/Debugging +### Developing/Debugging Flow Launcher's target framework is .Net 5 From a3e4e1ba54a5d0692bd97a3eb60f7ecf542942cd Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sat, 3 Jul 2021 19:20:02 +1000 Subject: [PATCH 08/10] Rename discussion.md to discussion.md.not_used --- .github/ISSUE_TEMPLATE/{discussion.md => discussion.md.not_used} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{discussion.md => discussion.md.not_used} (100%) diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md.not_used similarity index 100% rename from .github/ISSUE_TEMPLATE/discussion.md rename to .github/ISSUE_TEMPLATE/discussion.md.not_used From 354b414d4cbe62e0cf7b9c1cd2cb6aed4e5f9af1 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sat, 3 Jul 2021 19:26:13 +1000 Subject: [PATCH 09/10] update typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ee71127aa85..d831fa8ff38 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be

Features • Getting Started • - Question/Suggestion • + Questions/Suggestions • Development • Documentation

@@ -76,7 +76,7 @@ Vist [here](https://flow-launcher.github.io/docs/#/plugins) for our plugin portf If you are keen to write your own plugin for flow, please take a look at our plugin development documentation for [C#](https://flow-launcher.github.io/docs/#/develop-csharp-plugins) or [Python](https://flow-launcher.github.io/docs/#/develop-py-plugins) -## Question/Suggestion +## Questions/Suggestions Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/q-a) section. From 6306da72d291a35561ceb0e8465490f28b18a349 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sat, 3 Jul 2021 19:28:05 +1000 Subject: [PATCH 10/10] update typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d831fa8ff38..e9c7e33606f 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Windows may complain about security due to code not being signed, this will be c Flow searches files and contents via Windows Index Search, to use **Everything**: `pm install everything`. -If you are using Python plugins, Flow will prompt to either select the location or allow Python (Embeddable) to be automatic downloaded for use. +If you are using Python plugins, flow will prompt to either select the location or allow Python (Embeddable) to be automatic downloaded for use. Vist [here](https://flow-launcher.github.io/docs/#/plugins) for our plugin portfolio.