|
1 |
| -WoX |
2 |
| -=== |
| 1 | +Flow Launcher |
| 2 | +============= |
3 | 3 |
|
4 | 4 | 
|
5 |
| -[](https://github.com/jjw24/Flow.Launcher/releases/latest) |
6 |
| - |
7 |
| - |
8 |
| -[](https://dev.azure.com/Flow.Launcher-Launcher/Flow.Launcher/_build/latest?definitionId=1&branchName=master) |
9 |
| -[](https://github.com/jjw24/Flow.Launcher/releases) |
10 |
| -[](https://github.com/LunaGao/BlessYourCodeTag) |
| 5 | +[](https://github.com/Flow-Launcher/Flow.Launcher/releases) |
| 6 | +[](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) |
| 7 | + |
| 8 | +[](https://dev.azure.com/Flow-Launcher/Flow.Launcher/_build/latest?definitionId=1&branchName=master) |
11 | 9 |
|
12 |
| -**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. |
| 10 | +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. |
13 | 11 |
|
14 |
| - |
| 12 | +<sub>Remember to star it, flow will love you more :)</sub> |
15 | 13 |
|
16 |
| -Features |
17 |
| --------- |
| 14 | +## Features |
18 | 15 |
|
19 |
| -- Search for everything—applications, **uwp**, folders, files and more. |
20 |
| -- Use *pinyin* to search for programs / 支持用 **拼音** 搜索程序 |
21 |
| - - wyy / wangyiyun → 网易云音乐 |
22 |
| -- Keyword plugin search `g search_term` |
23 |
| -- Search youtube, google, twitter and many more |
24 |
| -- Build custom themes at http://www.wox.one/theme/builder |
25 |
| -- Install plugins from http://www.wox.one/plugin |
| 16 | +- Search everything from applications, folders, bookmarks, YouTube, Twitter and more. All from the comfort of your keyboard without ever touching the mouse. |
| 17 | +- Run batch and PowerShell commands as Administrator or a different user. |
| 18 | +- Support languages from Chinese to Italian and more. |
| 19 | +- Support of wide range of plugins. |
| 20 | +- Fully portable. |
26 | 21 |
|
27 |
| -**New from this fork:** |
28 |
| -- Upgraded to .Net Core 3.1 |
29 |
| -- Portable mode |
30 |
| -- Drastically improved search experience |
31 |
| -- Auto-complete text suggestion |
32 |
| -- Search all subfolders and files |
33 |
| -- Option to always run CMD or Powershell as administrator |
34 |
| -- Run CMD, Powershell and programs as a different user |
35 |
| -- Manage what programs should be loaded |
36 |
| -- Highlighting of how results are matched during query search |
37 |
| -- Open web search result as a tab or a new window |
38 |
| -- Automatic update |
39 |
| -- Reload/update plugin data |
| 22 | +## Running Flow Launcher |
40 | 23 |
|
41 |
| -Installation |
42 |
| ------------- |
| 24 | +| [Windows 7 and up](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) |
| 25 | +| ------------- | |
43 | 26 |
|
44 |
| -View new features released from this fork since Flow.Launcher v1.3.524: [new releases](https://github.com/jjw24/Flow.Launcher/releases) |
| 27 | +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. |
45 | 28 |
|
46 |
| -To install this fork's version of Flow.Launcher, you can **download** it [here](https://github.com/jjw24/Flow.Launcher/releases/latest). |
| 29 | +**Integrations:** |
| 30 | + - 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 |
| 31 | + - 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 |
47 | 32 |
|
48 |
| -To install the upstream version: |
| 33 | +**Usage** |
| 34 | +- Open flow's search window: <kbd>Alt</kbd>+<kbd>Space</kbd> is the default hotkey |
| 35 | +- Open context menu: <kbd>Ctrl</kbd>+<kbd>O</kbd>/<kbd>Shift</kbd>+<kbd>Enter</kbd> |
| 36 | +- Cancel/Return to previous screen: <kbd>Esc</kbd> |
| 37 | +- Install/Uninstall plugins: in the search window, type `wpm install/uninstall` + the plugin name |
| 38 | +- Saved user settings are located: |
| 39 | + - If using roaming: `%APPDATA%\FlowLauncher` |
| 40 | + - If using portable, by default: `%localappdata%\FlowLauncher\app-<VersionOfYourFlowLauncher>\UserData` |
| 41 | +- Logs are saved along with your user settings folder |
49 | 42 |
|
50 |
| -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) |
| 43 | +## Status |
51 | 44 |
|
52 |
| -Windows may complain about security due to code not being signed. This will be fixed later. |
| 45 | +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. |
53 | 46 |
|
54 |
| -Versions marked as **pre-release** are unstable pre-release versions. |
| 47 | +## Contributing |
55 | 48 |
|
56 |
| -- Requirements: |
57 |
| - - 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 |
58 |
| - - If you use python plugins, install [python3](https://www.python.org/downloads/): `.exe` installer + add it to `%PATH%` or set it in WoX settings |
| 49 | +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. |
59 | 50 |
|
60 |
| -Usage |
61 |
| ------ |
| 51 | +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. |
62 | 52 |
|
63 |
| -- Launch: <kbd>Alt</kbd>+<kbd>Space</kbd> |
64 |
| -- Context Menu: <kbd>Ctrl</kbd>+<kbd>O</kbd> |
65 |
| -- Cancel/Return: <kbd>Esc</kbd> |
66 |
| -- Install/Uninstall plugin: type `wpm install/uninstall` |
67 |
| -- Reset: delete `%APPDATA%\Flow.Launcher` |
68 |
| -- Log: `%APPDATA%\Flow.Launcher\Logs` |
| 53 | +**Question/Suggestion** |
69 | 54 |
|
70 |
| -Contribution |
71 |
| ------------- |
| 55 | +Yes please, submit an issue to let us know. |
72 | 56 |
|
73 |
| -- First and most importantly, star it! |
74 |
| -- Read [Coding Style](https://github.com/Flow.Launcher-launcher/Flow.Launcher/wiki/Coding-Style) |
75 |
| -- Send PR to **dev** branch |
76 |
| -- 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 |
77 |
| -- Don't hesitate to ask questions in the [issues](https://github.com/Flow.Launcher-launcher/Flow.Launcher/issues) |
| 57 | +## Developing/Debugging |
78 | 58 |
|
79 |
| -Developing/Debugging |
80 |
| ------ |
| 59 | +Flow Launcher's target framework is .Net Core 3.1 |
81 | 60 |
|
82 | 61 | Install Visual Studio 2019
|
83 |
| -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. |
84 | 62 |
|
85 |
| -Documentation |
86 |
| -------------- |
87 |
| -- [Wiki](https://github.com/jjw24/Flow.Launcher/wiki) |
88 |
| -- Outdated doc: [WoX doc](http://doc.wox.one). |
89 |
| -- Just ask questions in [issues](https://github.com/jjw24/Flow.Launcher/issues) for now. |
| 63 | +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) |
| 64 | + |
| 65 | +## Documentation |
| 66 | + |
| 67 | +[Wiki](https://github.com/Flow-Launcher/Flow.Launcher/wiki) |
| 68 | + |
| 69 | +## A history of the flow |
| 70 | +Flow's roots came from a rebrand of the [JJW24/Wox fork](https://github.com/jjw24/Wox/issues/156) and WoX. |
| 71 | + |
| 72 | +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. |
| 73 | + |
| 74 | +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 |
0 commit comments