From 7008eb7ab04e59a7ba9501a4ce7b3124da24d35a Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sat, 25 Apr 2020 17:46:43 +1000 Subject: [PATCH 1/5] Update readme- First cut --- README.md | 122 ++++++++++++++++++++++++------------------------------ 1 file changed, 54 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 1cd1c74a8..f0b219ab8 100644 --- a/README.md +++ b/README.md @@ -1,89 +1,75 @@ -WoX -=== +Flow Launcher +============= ![Maintenance](https://img.shields.io/maintenance/yes/2020) -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/jjw24/wox)](https://github.com/jjw24/Flow.Launcher/releases/latest) -![GitHub Release Date](https://img.shields.io/github/release-date/jjw24/wox) -![GitHub commits since latest release](https://img.shields.io/github/commits-since/jjw24/wox/v1.3.524) -[![Build Status](https://dev.azure.com/Flow.Launcher-Launcher/Flow.Launcher/_apis/build/status/jjw24.Flow.Launcher?branchName=master)](https://dev.azure.com/Flow.Launcher-Launcher/Flow.Launcher/_build/latest?definitionId=1&branchName=master) -[![Github All Releases](https://img.shields.io/github/downloads/jjw24/Flow.Launcher/total.svg)](https://github.com/jjw24/Flow.Launcher/releases) -[![RamenBless](https://cdn.rawgit.com/LunaGao/BlessYourCodeTag/master/tags/ramen.svg)](https://github.com/LunaGao/BlessYourCodeTag) +[![Github All Releases](https://img.shields.io/github/downloads/Flow-Launcher/Flow.Launcher/total.svg)](https://github.com/Flow-Launcher/Flow.Launcher/releases) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Flow-Launcher/Flow.Launcher)](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) +![GitHub Release Date](https://img.shields.io/github/release-date/Flow-Launcher/Flow.Launcher) +[![Build Status](https://dev.azure.com/Flow-Launcher/Flow.Launcher/_apis/build/status/Flow.Launcher?branchName=master)](https://dev.azure.com/Flow-Launcher/Flow.Launcher/_build/latest?definitionId=1&branchName=master) -**WoX** is a launcher for Windows that simply works. It's an alternative to [Alfred](https://www.alfredapp.com/) and [Launchy](http://www.launchy.net/). You can call it Windows omni-eXecutor if you want a long name. +Nickname flow, full name Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at being more than an app launcher, it searches, integrates and expands on functionalities. Flow will continue to evolve, designed to be open and built with the community at heart. -![demo](http://i.imgur.com/DtxNBJi.gif) +PS. Flowy is its street name. -Features --------- +## Status -- Search for everything—applications, **uwp**, folders, files and more. -- Use *pinyin* to search for programs / 支持用 **拼音** 搜索程序 - - wyy / wangyiyun → 网易云音乐 -- Keyword plugin search `g search_term` -- Search youtube, google, twitter and many more -- Build custom themes at http://www.wox.one/theme/builder -- Install plugins from http://www.wox.one/plugin +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. -**New from this fork:** -- Upgraded to .Net Core 3.1 -- Portable mode -- Drastically improved search experience -- Auto-complete text suggestion -- Search all subfolders and files -- Option to always run CMD or Powershell as administrator -- Run CMD, Powershell and programs as a different user -- Manage what programs should be loaded -- Highlighting of how results are matched during query search -- Open web search result as a tab or a new window -- Automatic update -- Reload/update plugin data +## Features -Installation ------------- +- Search everything from applications, folders, bookmarks, YouTube, Twitter and more. All from the comfort of your keyboard without ever touching the mouse. +- Run batch and PowerShell commands as Administrator or a different user. +- Support languages from Chinese to Italian and more. +- Support of wide range of plugins. +- Fully portable. -View new features released from this fork since Flow.Launcher v1.3.524: [new releases](https://github.com/jjw24/Flow.Launcher/releases) +## Running Flow Launcher +Remember to star it, flow will love you more :) -To install this fork's version of Flow.Launcher, you can **download** it [here](https://github.com/jjw24/Flow.Launcher/releases/latest). +| [Windows 7 and up](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) +| ------------- | -To install the upstream version: +Windows may complain about security due to code not being signed. This is fine, you can proceed to install it. -Download `Flow.Launcher-xxx.exe` from [releases](https://github.com/Flow.Launcher-launcher/Flow.Launcher/releases). Latest as of now is [`1.3.524`](https://github.com/Flow.Launcher-launcher/Flow.Launcher/releases/download/v1.3.524/Flow.Launcher-1.3.524.exe) ([`1.3.578`](https://github.com/Flow.Launcher-launcher/Flow.Launcher/releases/download/v1.3.578/Flow.Launcher-1.3.578.exe) for preview channel) - -Windows may complain about security due to code not being signed. This will be fixed later. - -Versions marked as **pre-release** are unstable pre-release versions. - -- Requirements: +**Integrations:** - If you want to integrate with [everything](https://www.voidtools.com/): `.exe` installer + use x64 if your windows is x64 + everything service is running. Supported version is 1.3.4.686 - - If you use python plugins, install [python3](https://www.python.org/downloads/): `.exe` installer + add it to `%PATH%` or set it in WoX settings + - If you use python plugins, install [python3](https://www.python.org/downloads/): `.exe` installer + add it to `%PATH%` or set it in flow's settings -Usage ------ +**Usage** +- Open flow: Alt+Space is the default hotkey +- Open context menu: Ctrl+O/Shift+Enter +- Cancel/Return to previous screen: Esc +- Install/Uninstall plugins: in the search window, type `wpm install/uninstall` + the plugin name +- Saved user settings are located: + - If using roaming: `%APPDATA%\FlowLauncher` + - If using portable, by default: `%localappdata%\FlowLauncher\app-\UserData` +- Logs are saved along with your user settings folder -- Launch: Alt+Space -- Context Menu: Ctrl+O -- Cancel/Return: Esc -- Install/Uninstall plugin: type `wpm install/uninstall` -- Reset: delete `%APPDATA%\Flow.Launcher` -- Log: `%APPDATA%\Flow.Launcher\Logs` +### Contributing -Contribution ------------- +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. -- First and most importantly, star it! -- Read [Coding Style](https://github.com/Flow.Launcher-launcher/Flow.Launcher/wiki/Coding-Style) -- Send PR to **dev** branch -- I'd appreciate if you could solve [help_needed](https://github.com/Flow.Launcher-launcher/Flow.Launcher/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp_needed) labeled issue -- Don't hesitate to ask questions in the [issues](https://github.com/Flow.Launcher-launcher/Flow.Launcher/issues) +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. -Developing/Debugging ------ +**Question/Suggestion** + +Yes please, submit an issue to let us know. + +### Developing/Debugging + +Flow Launcher's target framework is .Net Core 3.1 Install Visual Studio 2019 -Install [.Net Core 3.1 SDK](https://dotnet.microsoft.com/download/dotnet-core/thank-you/sdk-3.1.201-windows-x64-installer) or alternatively via Visual Studio installer. -Documentation -------------- -- [Wiki](https://github.com/jjw24/Flow.Launcher/wiki) -- Outdated doc: [WoX doc](http://doc.wox.one). -- Just ask questions in [issues](https://github.com/jjw24/Flow.Launcher/issues) for now. +Install .Net Core 3.1 SDK via Visual Studio installer or manually from [here](https://dotnet.microsoft.com/download/dotnet-core/thank-you/sdk-3.1.201-windows-x64-installer) + +### Documentation + +[Wiki](https://github.com/Flow-Launcher/Flow.Launcher/wiki) + +### A history of the flow +Flowy's roots came from a rebrand of the [JJW24/Wox fork](https://github.com/jjw24/Wox/issues/156) and WoX. + +A big thank you and all credits to [Bao](https://github.com/bao-qian), the author of WoX, and its contrbutors for all the amazing work. + +The JJW24/Wox fork started adding new changes on top of main WoX repo's code base from release v1.3.524. Flowy is a continuation of the work from JJW24/Wox \ No newline at end of file From 002d37c726e1b808e968a1ace8b6c92a5a9a8403 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sun, 26 Apr 2020 21:37:22 +1000 Subject: [PATCH 2/5] Update per suggestion --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f0b219ab8..ac8fd9c2e 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,7 @@ Flow Launcher ![GitHub Release Date](https://img.shields.io/github/release-date/Flow-Launcher/Flow.Launcher) [![Build Status](https://dev.azure.com/Flow-Launcher/Flow.Launcher/_apis/build/status/Flow.Launcher?branchName=master)](https://dev.azure.com/Flow-Launcher/Flow.Launcher/_build/latest?definitionId=1&branchName=master) -Nickname flow, full name Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at being more than an app launcher, it searches, integrates and expands on functionalities. Flow will continue to evolve, designed to be open and built with the community at heart. - -PS. Flowy is its street name. +Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at being more than an app launcher, it searches, integrates and expands on functionalities. Flow will continue to evolve, designed to be open and built with the community at heart. ## Status @@ -24,12 +22,11 @@ Flow is under heavy development, but the code base is stable, so contributions a - Fully portable. ## Running Flow Launcher -Remember to star it, flow will love you more :) | [Windows 7 and up](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) | ------------- | -Windows may complain about security due to code not being signed. This is fine, you can proceed to install it. +Windows may complain about security due to code not being signed, this will be completed at a later stage. If you downloaded from this repo, you are good to continue the set up. **Integrations:** - If you want to integrate with [everything](https://www.voidtools.com/): `.exe` installer + use x64 if your windows is x64 + everything service is running. Supported version is 1.3.4.686 @@ -68,8 +65,8 @@ Install .Net Core 3.1 SDK via Visual Studio installer or manually from [here](ht [Wiki](https://github.com/Flow-Launcher/Flow.Launcher/wiki) ### A history of the flow -Flowy's roots came from a rebrand of the [JJW24/Wox fork](https://github.com/jjw24/Wox/issues/156) and WoX. +Flow's roots came from a rebrand of the [JJW24/Wox fork](https://github.com/jjw24/Wox/issues/156) and WoX. A big thank you and all credits to [Bao](https://github.com/bao-qian), the author of WoX, and its contrbutors for all the amazing work. -The JJW24/Wox fork started adding new changes on top of main WoX repo's code base from release v1.3.524. Flowy is a continuation of the work from JJW24/Wox \ No newline at end of file +The JJW24/Wox fork started adding new changes on top of main WoX repo's code base from release v1.3.524. Flow is a continuation of the work from JJW24/Wox From 18dfcf1a9978af68b360325d13dc98d520dc5fe4 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sun, 26 Apr 2020 21:43:52 +1000 Subject: [PATCH 3/5] Move status down --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ac8fd9c2e..2e071ec15 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,6 @@ Flow Launcher Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at being more than an app launcher, it searches, integrates and expands on functionalities. Flow will continue to evolve, designed to be open and built with the community at heart. -## Status - -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. - ## Features - Search everything from applications, folders, bookmarks, YouTube, Twitter and more. All from the comfort of your keyboard without ever touching the mouse. @@ -42,7 +38,11 @@ Windows may complain about security due to code not being signed, this will be c - If using portable, by default: `%localappdata%\FlowLauncher\app-\UserData` - Logs are saved along with your user settings folder -### Contributing +## Status + +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. + +## 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. @@ -60,11 +60,11 @@ Install Visual Studio 2019 Install .Net Core 3.1 SDK via Visual Studio installer or manually from [here](https://dotnet.microsoft.com/download/dotnet-core/thank-you/sdk-3.1.201-windows-x64-installer) -### Documentation +## Documentation [Wiki](https://github.com/Flow-Launcher/Flow.Launcher/wiki) -### A history of the flow +## A history of the flow Flow's roots came from a rebrand of the [JJW24/Wox fork](https://github.com/jjw24/Wox/issues/156) and WoX. A big thank you and all credits to [Bao](https://github.com/bao-qian), the author of WoX, and its contrbutors for all the amazing work. From cc409d8a5b04c2f39f4776da2cd52883ea3dd7bd Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Sun, 26 Apr 2020 21:52:44 +1000 Subject: [PATCH 4/5] Minor updates --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e071ec15..84831d039 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Windows may complain about security due to code not being signed, this will be c - If you use python plugins, install [python3](https://www.python.org/downloads/): `.exe` installer + add it to `%PATH%` or set it in flow's settings **Usage** -- Open flow: Alt+Space is the default hotkey +- Open flow's search window: Alt+Space is the default hotkey - Open context menu: Ctrl+O/Shift+Enter - Cancel/Return to previous screen: Esc - Install/Uninstall plugins: in the search window, type `wpm install/uninstall` + the plugin name @@ -52,7 +52,7 @@ You will find the main goals of flow placed under Projects board, so feel free t Yes please, submit an issue to let us know. -### Developing/Debugging +## Developing/Debugging Flow Launcher's target framework is .Net Core 3.1 From 8077d3e8734230c35407da7712cbfd5f3d020905 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Mon, 27 Apr 2020 21:17:18 +1000 Subject: [PATCH 5/5] Add 'star it' message --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 84831d039..02baf9a9c 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ Flow Launcher Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at being more than an app launcher, it searches, integrates and expands on functionalities. Flow will continue to evolve, designed to be open and built with the community at heart. +Remember to star it, flow will love you more :) + ## Features - Search everything from applications, folders, bookmarks, YouTube, Twitter and more. All from the comfort of your keyboard without ever touching the mouse.