PowerToys/README.md
2015-11-04 05:04:08 +00:00

53 lines
2.9 KiB
Markdown

Wox [![Build status](https://ci.appveyor.com/api/projects/status/bfktntbivg32e103)](https://ci.appveyor.com/project/qianlifeng/wox) <a href="https://chocolatey.org/packages/wox"><img src="https://img.shields.io/badge/chocolatey-wox-b4884f.svg?style=flat" style="height:auto; width: 100%"></a> [![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)
=========
[Wox](http://www.getwox.com) is a launcher for windows, inspired by [Alfred](http://www.alfredapp.com/) and [Launchy](http://www.launchy.net/). Wox indexes your programs, your documents, project files, folders, and bookmarks. You can launch everything with just a few keystrokes!.
Features
=========
1. Search for applications, folders, files and in the browser bookmarks (using a plugin)
2. Search the web using shortcuts (e.g. search google with `g keyword` or Youtube `youtube keyword`)
3. Themes support, get more themes from [http://www.getwox.com/theme/builder](http://www.getwox.com/theme/builder)
4. Plugin support, get more plugins from [http://www.getwox.com/plugin](http://www.getwox.com/plugin)
Screenshot
=========
<a href="https://github.com/qianlifeng/Wox/wiki/Screenshot">More screenshot</a>
<img src="http://ww3.sinaimg.cn/large/dce48faejw1eihx6ffo8eg20zk0m8hdt.gif" />
Installation
=========
1. Download
1. Latest stable version: [release page](https://github.com/qianlifeng/Wox/releases).
2. Latest build: [history](https://ci.appveyor.com/project/qianlifeng/wox/history)
(top green build -> artifacts -> release-binary.zip).
2. Unzip it and put it into your user directory (`C:\Users\YOUUSERNAME` or `%userprofile%`)
3. Windows 10 user, please have a look at https://github.com/Wox-launcher/Wox/issues/279
Simple Usage
=========
- Launch: <kbd>Alt</kbd>+<kbd>Space</kbd>
- Install/Uninstall plugin: type `wpm install/uninstall`
- Remember type `restart` to restarat Wox after installation of a plugin
Contribute
=========
If you are a developer, 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/qianlifeng/Wox/issues) if you want to contribute :)
If you are not a developer, you can still contribute to the project. Install the beta version, test things and help us with new entries and corrections to the docs [Wox doc](http://doc.getwox.com). Feedback is always welcome!
Docs
=========
Full documentation can be found here [Wox Documentation](http://doc.getwox.com). This is a good place to start if you are installing Wox for the first time. Feel free to contribute if you want to improve, correct or translate the documentation.
In the future, all of the documentation will be moved back to Github wiki.
Discussion
=========
Do you have a question or an idea for a killer feature? Discuss things with our community at the [Wox Fourms](http://discussion.getwox.com).