diff --git a/README.md b/README.md index e7ea29e58..fe30839e8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,62 @@ -Wox [![Build status](https://ci.appveyor.com/api/projects/status/bfktntbivg32e103/branch/dev)](https://ci.appveyor.com/project/qianlifeng/wox/branch/dev) +Wox [![Build status](https://ci.appveyor.com/api/projects/status/bfktntbivg32e103)](https://ci.appveyor.com/project/qianlifeng/wox) +========= +[Wox](http://www.getwox.com) is an effective launcher for windows, which was inspired by [Alfred](http://www.alfredapp.com/) and [Launchy](http://www.launchy.net/). Wox provide bundles of features let you access infomations quickly. + +Features +========= +1. Search applications, files (via everything plugin) and chrome bookmarks +2. Search web contents with shortcuts (e.g. search google with `g keyword` or `youtube keyword`) +3. Search clipboard history (via clipboard plugin) +4. Themes support, get more themes from [http://www.getwox.com/theme](http://www.getwox.com/theme) +5. Plugin support, get more plugins from [http://www.getwox.com/plugin](http://www.getwox.com/plugin) + +Screenshot ========= -This is Wox Dev branch. We will develop new feature here and merge to master when we want to release a new version. -**Please send pull request to this branch if you want to contribute codes** +More screenshot + + +Download +========= + +Download from [release page](https://github.com/qianlifeng/Wox/releases). + +* **Windows XP users:** You have to install [.NET Framework 3.5](http://www.microsoft.com/download/details.aspx?id=22) if you have not installed yet. +* **Windows 8 users:** You have to [enable the .NET Framework 3.5 in Control Panel](http://msdn.microsoft.com/library/hh506443.aspx). + + +Contribute +========= + +If you are a developer, please feel free to send a pull request to **Dev** branch. We still have a lot functions and bugs need to do now. Just pick one from [issues page](https://github.com/qianlifeng/Wox/issues) that you think you can fix. + +If you are not a developer, you can also help Wox by contributing the Wox wiki page, for example [Wox Function Guide](https://github.com/qianlifeng/Wox/wiki/Wox-Function-Guide). + + + +Create and Share Plugin +========= + +Currently, Wox support using C# and Python to write your plugins. Please refer to [Create-plugin](https://github.com/qianlifeng/Wox/wiki/Create-plugins) page for more infomation. +You can share your plugin with WoxPlugins. After you upload your plugin, other uses can download or search your plugin through `wpm install ` command (this is a plugin for plugin management, which is one of the default plugins inside Wox). Please refer to [How-to-share-your-plugins](https://github.com/qianlifeng/Wox/wiki/How-to-share-your-plugins-in--getwox.com-plugin-page%3F) for details. + + +Create and Share Theme +========= + +Wox provide an online theme editor [http://www.getwox.com/themebuilder](http://www.getwox.com/themebuilder), you build your own theme for wox. + + + +Most Asked Questions +========= + +1. **How to install plugin?** + + Refer to [https://github.com/qianlifeng/Wox/wiki/How-to-install-Plugins](https://github.com/qianlifeng/Wox/wiki/How-to-install-Plugins) + + +2. **How to open setting dialog?** + + Refer to [https://github.com/qianlifeng/Wox/wiki/How-to-open-setting-dialog](https://github.com/qianlifeng/Wox/wiki/How-to-open-setting-dialog) +