README.md 3.0 KB
Newer Older
1 2 3
WoX
===

J
Jeremy Wu 宸叉彁浜
4
![Maintenance](https://img.shields.io/maintenance/yes/2020)
B
fix ci  
bao-qian 宸叉彁浜
5
[![Build status](https://ci.appveyor.com/api/projects/status/bfktntbivg32e103?svg=true)](https://ci.appveyor.com/project/bao-qian/wox)
B
bao-qian 宸叉彁浜
6 7
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Wox-launcher/wox?include_prereleases)](https://github.com/Wox-launcher/Wox/releases)
![GitHub Release Date](https://img.shields.io/github/release-date-pre/Wox-launcher/wox?nclude_prereleases)
B
bao-qian 宸叉彁浜
8
[![Github All Releases](https://img.shields.io/github/downloads/Wox-launcher/Wox/total.svg)](https://github.com/Wox-launcher/Wox/releases)
B
bao-qian 宸叉彁浜
9

B
bao-qian 宸叉彁浜
10

B
bao-qian 宸叉彁浜
11
**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/).
B
bao-qian 宸叉彁浜
12

B
fixup  
bao-qian 宸叉彁浜
13
![demo](http://i.imgur.com/DtxNBJi.gif)
Q
qianlifeng 宸叉彁浜
14

15 16 17
Features
--------

B
bao-qian 宸叉彁浜
18
- Search for everything鈥攁pplications, **UWP**, folders, files and more.
19
- Use *pinyin* to search for programs / 鏀寔鐢 **鎷奸煶** 鎼滅储绋嬪簭
Y
YC L 宸叉彁浜
20
  - wyy / wangyiyun 鈫 缃戞槗浜戦煶涔
21 22
- Keyword plugin search `g search_term`
- Search youtube, google, twitter and many more
B
bao-qian 宸叉彁浜
23 24
- Build custom themes at http://www.wox.one/theme/builder
- Install plugins from http://www.wox.one/plugin
25
- Portable mode
26
- Auto-complete text suggestion
27
- Highlighting of how results are matched during query search
B
bao-qian 宸叉彁浜
28

B
Boris Makogonyuk 宸叉彁浜
29

30 31
Installation
------------
B
bao-qian 宸叉彁浜
32

B
bao-qian 宸叉彁浜
33 34 35 36
- Download from [releases](https://github.com/Wox-launcher/Wox/releases).
  - Option 1: download `Wox-Full-Installer.*.exe`, which include all dependency.
  - Option 2: download `Wox.*.exe`, which only include wox itself. You may install Everything and Python using below instruction.
- Windows may complain about security due to code not being signed. This will be fixed later. 
B
bao-qian 宸叉彁浜
37

B
bao-qian 宸叉彁浜
38
- Requirements:
B
bao-qian 宸叉彁浜
39 40 41
  - .NET >= 4.6.2 or Windows version >= 10 1607 (Anniversary Update)
  - [Optional] Integrate with everything
    1. Download `.exe` [installer](https://www.voidtools.com/)
42 43
    2. Use x64 if your windows is x64
    3. Version >= 1.4.1 is supported
B
bao-qian 宸叉彁浜
44 45
  - [Optional] Use Python plugins
    1. install [python3](https://www.python.org/downloads/)
B
bao-qian 宸叉彁浜
46
    2. add it to `%PATH%` or set it in WoX settings
B
bao-qian 宸叉彁浜
47

48 49 50
Usage
-----

Q
qianlifeng 宸叉彁浜
51
- Launch: <kbd>Alt</kbd>+<kbd>Space</kbd>
J
Jeremy Wu 宸叉彁浜
52 53
- Context Menu: <kbd>Ctrl</kbd>+<kbd>O</kbd>
- Cancel/Return: <kbd>Esc</kbd>
B
bao-qian 宸叉彁浜
54
- Install/Uninstall plugin: type `wpm install/uninstall`
B
bao-qian 宸叉彁浜
55
- Reset: delete `%APPDATA%\Wox`
B
bao-qian 宸叉彁浜
56
- Log: `%APPDATA%\Wox\Logs`
B
bao-qian 宸叉彁浜
57

58 59 60
Contribution
------------

B
bao-qian 宸叉彁浜
61
- First and most importantly, star it!
B
bao-qian 宸叉彁浜
62
- Send PR to master branch
B
bao-qian 宸叉彁浜
63
- I'd appreciate if you could solve [help_wanted](https://github.com/Wox-launcher/Wox/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) labeled issue
64

B
bao-qian 宸叉彁浜
65 66 67
Build
-----

A
a typo  
Andrea Borruso 宸叉彁浜
68
Install Visual Studio 2019 with .NET desktop development and Universal Windows Platform development
I
Itzik S 宸叉彁浜
69

70 71
Documentation
-------------
B
bao-qian 宸叉彁浜
72
- [Wiki](https://github.com/Wox-launcher/Wox/wiki)
B
bao-qian 宸叉彁浜
73
- Outdated doc: [WoX doc](http://doc.wox.one).
B
bao-qian 宸叉彁浜
74
- Just ask questions in [issues](https://github.com/Wox-launcher/Wox/issues) for now.
B
bao-qian 宸叉彁浜
75 76 77 78 79 80 81 82

Thanks
------

I would like to thank

- [Raygun](https://raygun.com/) for their free crash reporting account.
- JetBrains for Open Source licence.