PowerToys/README.md

87 lines
3.9 KiB
Markdown
Raw Normal View History

WoX
===
![Maintenance](https://img.shields.io/maintenance/yes/2020)
2019-09-22 19:54:44 +08:00
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/jjw24/wox)](https://github.com/jjw24/Wox/releases/latest)
2019-09-22 19:38:20 +08: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-01-13 03:50:39 +08:00
[![Build Status](https://dev.azure.com/Wox-Launcher/Wox/_apis/build/status/jjw24.Wox?branchName=master)](https://dev.azure.com/Wox-Launcher/Wox/_build/latest?definitionId=1&branchName=master)
[![Github All Releases](https://img.shields.io/github/downloads/jjw24/Wox/total.svg)](https://github.com/jjw24/Wox/releases)
2016-07-05 22:44:14 +08:00
[![RamenBless](https://cdn.rawgit.com/LunaGao/BlessYourCodeTag/master/tags/ramen.svg)](https://github.com/LunaGao/BlessYourCodeTag)
2015-12-16 04:41:41 +08: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 23:29:38 +08:00
2015-12-14 08:21:03 +08:00
![demo](http://i.imgur.com/DtxNBJi.gif)
2015-11-03 23:34:59 +08:00
Features
--------
2017-03-02 08:29:18 +08:00
- Search for everything—applications, **uwp**, folders, files and more.
- Use *pinyin* to search for programs / 支持用 **拼音** 搜索程序
- wyy / wangyiyun → 网易云音乐
- Keyword plugin search
- search google with `g search_term`
2018-02-25 02:18:35 +08:00
- Build custom themes at http://www.wox.one/theme/builder
- Install plugins from http://www.wox.one/plugin
2016-04-24 23:29:38 +08:00
2016-11-12 05:12:55 +08:00
Installation
------------
2016-04-24 23:29:38 +08:00
2019-11-08 02:47:54 +08:00
View new features released from this fork since Wox v1.3.524: [new releases](https://github.com/jjw24/Wox/releases)
2019-09-30 20:58:02 +08:00
To install this fork's version of Wox, you can **download** it [here](https://github.com/jjw24/Wox/releases/latest).
To install the upstream version:
2018-12-22 12:48:16 +08:00
Download `Wox-xxx.exe` from [releases](https://github.com/Wox-launcher/Wox/releases). Latest as of now is [`1.3.524`](https://github.com/Wox-launcher/Wox/releases/download/v1.3.524/Wox-1.3.524.exe) ([`1.3.578`](https://github.com/Wox-launcher/Wox/releases/download/v1.3.578/Wox-1.3.578.exe) for preview channel)
2016-11-11 19:41:33 +08:00
Windows may complain about security due to code not being signed. This will be fixed later.
2016-05-18 22:02:29 +08:00
Versions marked as **pre-release** are unstable pre-release versions.
2016-05-18 22:02:29 +08:00
- Requirements:
- .net >= 4.5.2
2016-06-11 07:18:49 +08:00
- [everything](https://www.voidtools.com/): `.exe` installer + use x64 if your windows is x64 + everything service is running
- [python3](https://www.python.org/downloads/): `.exe` installer + add it to `%PATH%` or set it in WoX settings
2015-11-04 07:21:27 +08:00
Usage
-----
2015-11-04 10:04:54 +08:00
- Launch: <kbd>Alt</kbd>+<kbd>Space</kbd>
2019-12-24 17:16:27 +08:00
- Context Menu: <kbd>Ctrl</kbd>+<kbd>O</kbd>
- Cancel/Return: <kbd>Esc</kbd>
2015-11-04 07:21:27 +08:00
- Install/Uninstall plugin: type `wpm install/uninstall`
2016-08-21 08:56:35 +08:00
- Reset: delete `%APPDATA%\Wox`
2017-03-02 08:30:06 +08:00
- Log: `%APPDATA%\Wox\Logs`
2017-03-02 08:27:16 +08:00
Contribution
------------
2016-05-12 07:54:40 +08:00
- First and most importantly, star it!
2017-03-02 08:16:58 +08:00
- Read [Coding Style](https://github.com/Wox-launcher/Wox/wiki/Coding-Style)
2016-05-10 05:05:38 +08:00
- Send PR to **dev** branch
2016-05-10 05:08:55 +08:00
- I'd appreciate if you could solve [help_needed](https://github.com/Wox-launcher/Wox/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp_needed) labeled issue
2016-05-10 05:05:38 +08:00
- Don't hesitate to ask questions in the [issues](https://github.com/Wox-launcher/Wox/issues)
2017-03-31 18:39:20 +08:00
Build
-----
Install Visual Studio 2015/2017/2019
This project requires Windows 10 SDK:
VS 2015:
- Tick all Windows 10 sdk options
VS 2017/2019 and later:
- Last Windows 10 SDK which [supported](https://github.com/Wox-launcher/Wox/pull/1827#commitcomment-26475392) UwpDesktop is version 10.0.14393.795. It is needed to compile "Programs" Plugin (UWP.cs), you will see the "References" of Plugin.Programs as broken if you use a later SDK version.
- This SDK cannot be installed via VS 2019 installer.
- Download and install [Windows 10 SDK version 10.0.14393.795](https://go.microsoft.com/fwlink/p/?LinkId=838916).
2019-06-24 23:01:00 +08:00
Documentation
-------------
2017-03-02 08:29:18 +08:00
- [Wiki](https://github.com/Wox-launcher/Wox/wiki)
2018-02-25 02:18:35 +08:00
- Outdated doc: [WoX doc](http://doc.wox.one).
- Just ask questions in [issues](https://github.com/Wox-launcher/Wox/issues) for now.