Flow.Launcher/README.md

90 lines
4.4 KiB
Markdown
Raw Normal View History

WoX
===
![Maintenance](https://img.shields.io/maintenance/yes/2020)
2020-04-21 09:12:17 +00:00
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/jjw24/wox)](https://github.com/jjw24/Flow.Launcher/releases/latest)
2019-09-22 11:38:20 +00:00
![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)
2020-04-21 09:12:17 +00:00
[![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)
2016-07-05 14:44:14 +00:00
[![RamenBless](https://cdn.rawgit.com/LunaGao/BlessYourCodeTag/master/tags/ramen.svg)](https://github.com/LunaGao/BlessYourCodeTag)
2015-12-15 20:41:41 +00:00
**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.
2016-04-24 15:29:38 +00:00
2015-12-14 00:21:03 +00:00
![demo](http://i.imgur.com/DtxNBJi.gif)
2015-11-03 15:34:59 +00:00
Features
--------
2017-03-02 00:29:18 +00:00
- 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
2018-02-24 18:18:35 +00:00
- Build custom themes at http://www.wox.one/theme/builder
- Install plugins from http://www.wox.one/plugin
2016-04-24 15:29:38 +00:00
**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
2016-11-11 21:12:55 +00:00
Installation
------------
2016-04-24 15:29:38 +00:00
2020-04-21 09:12:17 +00:00
View new features released from this fork since Flow.Launcher v1.3.524: [new releases](https://github.com/jjw24/Flow.Launcher/releases)
2019-11-07 18:47:54 +00:00
2020-04-21 09:12:17 +00:00
To install this fork's version of Flow.Launcher, you can **download** it [here](https://github.com/jjw24/Flow.Launcher/releases/latest).
To install the upstream version:
2020-04-21 09:12:17 +00:00
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)
2016-11-11 11:41:33 +00:00
Windows may complain about security due to code not being signed. This will be fixed later.
2016-05-18 14:02:29 +00:00
Versions marked as **pre-release** are unstable pre-release versions.
2016-05-18 14:02:29 +00:00
- Requirements:
- 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
2015-11-03 23:21:27 +00:00
Usage
-----
2015-11-04 02:04:54 +00:00
- Launch: <kbd>Alt</kbd>+<kbd>Space</kbd>
2019-12-24 09:16:27 +00:00
- Context Menu: <kbd>Ctrl</kbd>+<kbd>O</kbd>
- Cancel/Return: <kbd>Esc</kbd>
2015-11-03 23:21:27 +00:00
- Install/Uninstall plugin: type `wpm install/uninstall`
2020-04-21 09:12:17 +00:00
- Reset: delete `%APPDATA%\Flow.Launcher`
- Log: `%APPDATA%\Flow.Launcher\Logs`
2017-03-02 00:27:16 +00:00
Contribution
------------
2016-05-11 23:54:40 +00:00
- First and most importantly, star it!
2020-04-21 09:12:17 +00:00
- Read [Coding Style](https://github.com/Flow.Launcher-launcher/Flow.Launcher/wiki/Coding-Style)
2016-05-09 21:05:38 +00:00
- Send PR to **dev** branch
2020-04-21 09:12:17 +00:00
- 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)
Developing/Debugging
2017-03-31 10:39:20 +00:00
-----
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.
2019-06-24 15:01:00 +00:00
Documentation
-------------
2020-04-21 09:12:17 +00:00
- [Wiki](https://github.com/jjw24/Flow.Launcher/wiki)
2018-02-24 18:18:35 +00:00
- Outdated doc: [WoX doc](http://doc.wox.one).
2020-04-21 09:12:17 +00:00
- Just ask questions in [issues](https://github.com/jjw24/Flow.Launcher/issues) for now.