Skip to content

Commit

Permalink
README: 看来我是对奇怪的大小写有种强迫症(
Browse files Browse the repository at this point in the history
  • Loading branch information
Artoria2e5 committed May 20, 2016
1 parent 89503b8 commit cf5f966
Showing 1 changed file with 33 additions and 23 deletions.
56 changes: 33 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,63 @@
WoX
===

[![Gitter](https://badges.gitter.im/Wox-launcher/Wox.svg)](https://gitter.im/Wox-launcher/Wox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Build status](https://ci.appveyor.com/api/projects/status/bfktntbivg32e103)](https://ci.appveyor.com/project/happlebao/wox)
[![Github All Releases](https://img.shields.io/github/downloads/Wox-launcher/Wox/total.svg)](https://github.com/Wox-launcher/Wox/releases)
[![Issue Stats](http://issuestats.com/github/Wox-launcher/Wox/badge/pr)](http://issuestats.com/github/Wox-launcher/Wox)

=========

Launcher for Windows, an alternative to [Alfred](https://www.alfredapp.com/) and [Launchy](http://www.launchy.net/).

# Demo
**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.

![demo](http://i.imgur.com/DtxNBJi.gif)

# Features
Features
--------

- Search for everything—applications, folders, files and more.
- Use *pinyin* to search for programs / 支持用 **拼音** 搜索程序
- yyy / wangyiyun → 网易云音乐
- Keyword plugin search
- search google with `g search_term`
- Build custom themes at http://www.getwox.com/theme/builder
- Install plugins from http://www.getwox.com/plugin

- Search all applications, folders and files.
- Use **pinyin** to search programs / 支持用 **拼音** 搜索程序 e.g. yyy / wangyiyun -> 网易云音乐
- Search Web using keyword (e.g. search google with `g search_term`)
- Build custom themes in [http://www.getwox.com/theme/builder](http://www.getwox.com/theme/builder)
- Install plugins from [http://www.getwox.com/plugin](http://www.getwox.com/plugin)
Installation
------------

# Installation
Download [`setup.exe`](https://github.com/Wox-launcher/Wox/releases/download/latest/Setup.exe) from [releases](https://github.com/Wox-launcher/Wox/releases).
Just ignore Windows' complaints about security, we will sign the code in the future.

download `setup.exe`.
if windows complains about security, just run it. code will be signed in the future
Versions marked as **pre-release** are unstable pre-release versions.

- Requirements:
- .net >= 4.5.2
- [everything](https://www.voidtools.com/): `.exe` installer + use x64 if your windows is x64
- [python3](https://www.python.org/downloads/): `.exe` installer
- Stable: [releases](https://github.com/Wox-launcher/Wox/releases).
- Beta: try **Pre-release** labeled release in [releases](https://github.com/Wox-launcher/Wox/releases)

# Usage
Usage
-----

- Launch: <kbd>Alt</kbd>+<kbd>Space</kbd>
- Install/Uninstall plugin: type `wpm install/uninstall`

# Contribute
Contribution
------------

- First and most importantly, star it!
- Send PR to **dev** branch
- 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
- Don't hesitate to ask questions in the [issues](https://github.com/Wox-launcher/Wox/issues)
- 中文开发直接发我邮件我们聊 qq
- 中文开发直接发我邮件我们聊 QQ

Documentation
-------------

# Docs
Outdated doc: [WoX doc](http://doc.getwox.com).

Outdated doc: [Wox doc](http://doc.getwox.com).
Just ask questions in the [issues](https://github.com/Wox-launcher/Wox/issues)
Just ask questions in [issues](https://github.com/Wox-launcher/Wox/issues) for now.

# Development / Author Status
TODO
----

- [x] unified directory `%APPDATA%` for all storage
- [ ] bring unitest for wox back
Expand Down

0 comments on commit cf5f966

Please sign in to comment.