PowerToys/README.md

50 lines
2.9 KiB
Markdown
Raw Normal View History

2016-03-28 22:02:53 +08:00
[![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)
2015-12-16 04:41:41 +08:00
[![Build status](https://ci.appveyor.com/api/projects/status/bfktntbivg32e103)](https://ci.appveyor.com/project/qianlifeng/wox) [![Github All Releases](https://img.shields.io/github/downloads/Wox-launcher/Wox/total.svg)](https://github.com/Wox-launcher/Wox/releases)
[![Bountysource](https://www.bountysource.com/badge/team?team_id=39433&style=raised)](https://www.bountysource.com/teams/wox?utm_source=Wox&utm_medium=shield&utm_campaign=raised)
[![Issue Stats](http://issuestats.com/github/Wox-launcher/Wox/badge/pr)](http://issuestats.com/github/Wox-launcher/Wox)
2015-12-16 04:41:41 +08:00
2015-11-03 23:34:59 +08:00
=========
Wox is a launcher for Windows, an alternative to [Alfred](https://www.alfredapp.com/) and [Launchy](http://www.launchy.net/). You can launch everything with just a few keystrokes!
2015-11-26 19:09:56 +08:00
2015-12-14 08:19:53 +08:00
Demo
2015-11-26 19:09:56 +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
=========
1. Search all applications, folders, files, [bookmarks](http://www.getwox.com/plugin/16).
2015-11-11 04:05:18 +08:00
2. Search Web using keyword (e.g. search google with `g search_term`)
3. Build custom themes in [http://www.getwox.com/theme/builder](http://www.getwox.com/theme/builder)
4. Install plugins from [http://www.getwox.com/plugin](http://www.getwox.com/plugin)
2015-11-03 23:34:59 +08:00
2015-11-04 06:32:23 +08:00
Installation
2015-11-03 23:34:59 +08:00
=========
2015-11-04 12:46:29 +08:00
1. Download
1. Latest stable version: [release page](https://github.com/Wox-launcher/Wox/releases).
2015-11-26 13:33:44 +08:00
2. Latest build: [English guide](https://github.com/Wox-launcher/Wox/wiki/FAQ-English#how-to-install-latest-build), [中文说明](https://github.com/Wox-launcher/Wox/wiki/FAQ-%E4%B8%AD%E6%96%87#%E5%A6%82%E4%BD%95%E5%AE%89%E8%A3%85%E6%9C%80%E6%96%B0-build)
2015-11-04 12:46:29 +08:00
2. Unzip it and put it into your user directory (`C:\Users\YOUUSERNAME` or `%userprofile%`)
2015-11-04 06:32:23 +08:00
3. Windows 10 user, please have a look at https://github.com/Wox-launcher/Wox/issues/279
2015-11-03 23:34:59 +08:00
2015-11-04 07:21:27 +08:00
Simple Usage
=========
2015-11-04 10:04:54 +08:00
- Launch: <kbd>Alt</kbd>+<kbd>Space</kbd>
2015-11-04 07:21:27 +08:00
- Install/Uninstall plugin: type `wpm install/uninstall`
2015-11-03 23:34:59 +08:00
Contribute
=========
2015-12-01 05:57:07 +08:00
If you are a developer, please feel free to send a pull request to the **Dev** branch. We still have a lot of features and bugs to resolve. Take a look at [issues page](https://github.com/Wox-launcher/Wox/issues), especially for [help_needed](https://github.com/Wox-launcher/Wox/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp_needed) labeled issue. :)
2015-11-03 23:34:59 +08:00
2015-11-11 04:05:18 +08:00
If you are not a developer, please install the [Latest build](https://ci.appveyor.com/project/qianlifeng/wox/history) and report bugs (how to: [English](https://github.com/Wox-launcher/Wox/wiki/FAQ-English) [中文](https://github.com/Wox-launcher/Wox/wiki/FAQ-%E4%B8%AD%E6%96%87)). Feedback is always welcome!
2015-11-03 23:34:59 +08:00
Docs
=========
Full documentation can be found here [Wox doc](http://doc.getwox.com). This is a good place to start if you are installing Wox for the first time.
2015-11-03 23:34:59 +08:00
2015-11-04 07:21:27 +08:00
In the future, all of the documentation will be moved back to Github wiki.