-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dc06d16
commit 262f3c9
Showing
8 changed files
with
92 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| Wox | ||
| === | ||
|
|
||
| [](https://github.com/Wox-launcher/Wox/actions) | ||
| [](https://github.com/Wox-launcher/Wox/releases) | ||
| [](https://github.com/Wox-launcher/Wox/releases) | ||
| [](https://crowdin.com/project/woxlauncher) | ||
|
|
||
| **Wox** is a cross-platform launcher that simply works. It's an alternative to [Alfred](https://www.alfredapp.com/) and [Launchy](http://www.launchy.net/) | ||
|
|
||
|
|
||
| > Wox v2 is under active development, if you use windows, please check v1 release | ||
|
|
||
| Features | ||
| -------- | ||
|
|
||
| - Search for applications, folders, files and more | ||
| - Plenty of Plugins and Themes | ||
| - Single executable file, no installation required | ||
| - Develop plugins with Javascript, Python, C# | ||
|
|
||
| Run | ||
| ------------ | ||
|
|
||
| Download from [releases](https://github.com/Wox-launcher/Wox/releases) and run the single executable file | ||
|
|
||
| Usage | ||
| ----- | ||
|
|
||
| - Launch: <kbd>Alt</kbd>/<kbd>Command</kbd>+<kbd>Space</kbd> | ||
| - Cancel/Return: <kbd>Esc</kbd> | ||
| - Install/Uninstall plugin: type `wpm install/uninstall` | ||
|
|
||
| Contribution | ||
| ------------ | ||
|
|
||
| - First and most importantly, star it! | ||
| - Send PR | ||
| - Join [discussions](https://github.com/Wox-launcher/Wox/discussions) | ||
|
|
||
| Development | ||
| ----------- | ||
|
|
||
| - Install [just](https://github.com/casey/just) | ||
| - Install [Golang SDK](https://go.dev/dl/) | ||
| - Install [Nodejs](https://nodejs.org) and [pnpm](https://pnpm.io/) | ||
| - Install [Python](https://python.org/downloads) and [pip](https://pip.pypa.io/en/stable/installation/) | ||
| - Install [Flutter](https://docs.flutter.dev/get-started/install) | ||
| - Run `just dev` to build dependencies and start Wox in development mode | ||
|
|
||
| Documentation | ||
| ------------- | ||
|
|
||
| - [Wiki](https://github.com/Wox-launcher/Wox/wiki) | ||
|
|
||
| Project Activity | ||
| ------ | ||
|
|
||
|  |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| * [Home](/) | ||
| * [Plugin](Plugin.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>Document</title> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> | ||
| <meta name="description" content="Description"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"> | ||
| <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"> | ||
| </head> | ||
| <body> | ||
| <div id="app"></div> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify@4"></script> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify-edit-on-github"></script> | ||
|
|
||
| <script> | ||
| window.$docsify = { | ||
| loadSidebar: true, | ||
| name: "Wox", | ||
| repo: "https://github.com/Wox-launcher/Wox", | ||
| plugins: [ | ||
| EditOnGithubPlugin.create("https://github.com/Wox-launcher/Wox/tree/v2/Doc", null, | ||
| function(file) { | ||
| return "edit on github" | ||
| }) | ||
| ] | ||
| } | ||
| </script> | ||
| </body> | ||
| </html> |