diff --git a/README.md b/README.md index 884896777..2959c46be 100644 --- a/README.md +++ b/README.md @@ -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: Alt+Space - 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