Skip to content

Update readme #1059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 3, 2022
Merged

Update readme #1059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89720bd
update readme
jjw24 Mar 3, 2022
7cb47c6
formatting
jjw24 Mar 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Plugins/Flow.Launcher.Plugin.WebSearch/SearchSourceViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ internal ImageSource LoadPreviewIcon(string pathToPreviewIconImage)
return ImageLoader.Load(pathToPreviewIconImage);
}
}
}
}
62 changes: 30 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Dedicated to making your workflow flow more seamless. Search everything from app
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">


## 🎉 New Features in 1.9
## 🎉 New Features in 1.9

![screenshot](https://user-images.githubusercontent.com/6903107/144855345-45535bc7-7777-4c5a-b8d9-d6ce8adc5e84.png)

Expand All @@ -54,7 +54,7 @@ Dedicated to making your workflow flow more seamless. Search everything from app
| [Windows 7+ installer](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest/download/Flow-Launcher-Setup.exe) | [Portable](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest/download/Flow-Launcher-Portable.zip) | `winget install "Flow Launcher"` | `scoop install Flow-Launcher` |
| :----------------------------------------------------------: | :----------------------------------------------------------: | :------------------------------: | :------------------------------: |

> Windows may complain about security due to code not being signed, this will be completed at a later stage. If you downloaded from this repo, you are good to continue the set up.
> When installing for the first time Windows may raise an issue about security due to code not being signed, if you downloaded from this repo then you are good to continue the set up.

And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/discussions" target="_blank">early access version</a>.

Expand All @@ -67,14 +67,14 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
<img src="https://user-images.githubusercontent.com/6903107/145332614-74909973-f6eb-47c2-8235-289931e30718.png" width="400">


- Search for files or their contents.
- Search for apps, files or file contents.

<img src="https://user-images.githubusercontent.com/6903107/145018796-658b7c24-a34f-46b6-98d4-cf4f636d8b60.png" width="400">


- Support search using environment variable paths.

### Web Search & Open URL
### Web Searches & URLs

<img src="https://user-images.githubusercontent.com/6903107/144517502-5325de01-d0d9-4c2e-aafb-33c3f5d82f81.png" width="400">
<img src="https://user-images.githubusercontent.com/6903107/144831031-0e01e8ea-3247-4ba4-a7b4-48b0db620bc1.png" width="400">
Expand All @@ -88,14 +88,14 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis

<img src="https://user-images.githubusercontent.com/6903107/144517557-9b5b82fc-6408-48a0-af59-69b385a0782e.png" width="400">

- Provides System related commands. shutdown, lock, settings, etc.
- Provides system related commands. shutdown, lock, settings, etc.
- <a href="#system-command-list">System command list</a>

### Calculator

<img src="https://user-images.githubusercontent.com/6903107/144517570-f0e62716-3fdf-4f2a-8986-385a3fcd0663.png" width="400">

- Do mathematical calculations and copy the result to clipboard.
- Do mathematical calculations and copy the result to clipboard.

### Shell Command

Expand All @@ -110,11 +110,11 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis

- Save file or folder locations for quick access.

### Window Setting & Control Panel
### Windows & Control Panel Settings

<img src="https://user-images.githubusercontent.com/6903107/144982305-42a2f63e-0066-4557-9791-0a1c57495ea7.png" width="400">

- Search within Window Settings & Control Panel.
- Search for Windows & Control Panel settings.


### Priority
Expand All @@ -124,7 +124,7 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis

- Prioritise the order of each plugin's results.

### Customization
### Customizations

![Animation5](https://user-images.githubusercontent.com/6903107/144693887-1b92ed16-dca1-4b7e-8644-5e9524cdfb31.gif)

Expand All @@ -133,27 +133,27 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis

![themes](https://user-images.githubusercontent.com/6903107/144527796-7c06ca31-d933-4f6b-9eb0-4fb06fa94384.png)

- There are various themes and you can make it yourself.
- There are various themes and you also can make your own.

### 💬 Language

- Support languages from Chinese to Italian and more.
- Support Pinyin.
- Translation support this project in [Crowdin](https://crowdin.com/project/flow-launcher)
- Supports languages from Chinese to Italian and more.
- Supports Pinyin search.
- [Crowdin](https://crowdin.com/project/flow-launcher) support for language translations.

### Portable

- Fully portable.
- Type `flow user data` to open your saved user settings folder. They are located at:
- If using roaming: `%APPDATA%\FlowLauncher`
- If using portable, by default: `%localappdata%\FlowLauncher\app-<VersionOfYourFlowLauncher>\UserData`
- If using portable, by default: `%localappdata%\FlowLauncher\app-<VersionOfYourFlowLauncher>\UserData`
- Type `open log location` to open your logs folder, they are saved along with your user settings folder.

### 🎮 Game Mode

<img src="https://user-images.githubusercontent.com/6903107/144517711-a7396bbb-f7ae-403d-9644-1414edd9e3f1.png" width="150">

- Suspend the hotkey when you are playing games.
- Pause hotkey activation when you are playing games.

<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">

Expand All @@ -164,6 +164,7 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis

<p align="center">
<a href="https://flowlauncher.com/docs/#/develop-dotnet-plugins"><img src="https://user-images.githubusercontent.com/6903107/147870065-4096f233-147c-434e-a3ac-69519582605f.png" width="64"></a>
<a href="https://github.com/Flow-Launcher/plugin-samples/tree/master/HelloWorldFSharp"><img src="https://user-images.githubusercontent.com/26427004/156536959-dfdc7be8-4b59-4587-9c6a-a297903e4ce1.png" width="64"></a>
<a href="https://www.flowlauncher.com/docs/#/py-develop-plugins"><img src="https://user-images.githubusercontent.com/6903107/147870066-7599eb15-0333-468e-82e8-4d432ceb5a45.png" width="64"></a>
<a href="https://flowlauncher.com/docs/#/nodejs-develop-plugins"><img src="https://user-images.githubusercontent.com/6903107/147870071-d67c736b-0748-428f-a283-14587696dfa3.png" width="64"></a>
<a href="https://flowlauncher.com/docs/#/nodejs-develop-plugins"><img src="https://user-images.githubusercontent.com/6903107/147870069-9bde6fe6-d50c-4d85-8fde-fe5ae921ab8c.png" width="64"></a>
Expand Down Expand Up @@ -192,7 +193,7 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis

### Github
<img src="https://user-images.githubusercontent.com/6903107/144533497-8677f800-95c5-4758-8ca3-c96333ee1943.png" width="400">

### Window Walker
<img src="https://user-images.githubusercontent.com/6903107/144533517-07bf011f-726c-4221-8657-0e442eca8a82.png" width="400">

Expand All @@ -204,7 +205,7 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis

![pluginstore](https://user-images.githubusercontent.com/6903107/144528115-3b6baa89-f53f-40db-8426-02c4db8dd2b5.png)

- You can view the full plugin list or quickly install a plugin via the Plugin Store menu in Settings
- You can view the full plugin list or quickly install a plugin via the Plugin Store menu inside Settings

- or type `pm` `install`/`uninstall`/`update` + the plugin name in the search window,

Expand All @@ -215,18 +216,19 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis

| Hotkey | Description |
| ------------------------------------------------------------ | -------------------------------------------- |
| <kbd>Alt</kbd>+ <kbd>Space</kbd> | Open Search Box (default and configurable) |
| <kbd>Alt</kbd>+ <kbd>Space</kbd> | Open search window (default and configurable)|
| <kbd>Enter</kbd> | Execute |
| <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> | Run As Admin |
| <kbd>↑</kbd><kbd>↓</kbd> | Scroll up & Down |
| <kbd>←</kbd><kbd>→</kbd> | Back to Result / Open Context Menu |
| <kbd>Ctrl</kbd> +<kbd>o</kbd> , <kbd>Shift</kbd> +<kbd>Enter</kbd> | Open Context Menu |
| <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> | Run commands from Shell plugin as admin |
| <kbd>↑</kbd><kbd>↓</kbd> | Scroll up & down |
| <kbd>←</kbd><kbd>→</kbd> | Back to result / Open Context Menu |
| <kbd>Ctrl</kbd> +<kbd>O</kbd> , <kbd>Shift</kbd> +<kbd>Enter</kbd> | Open Context Menu |
| <kbd>Tab</kbd> | Autocomplete |
| <kbd>Esc</kbd> | Back to Result & Close |
| <kbd>Ctrl</kbd> +<kbd>i</kbd> | Open Setting Window |
| <kbd>F5</kbd> | Reload All Plugin Data & Window Search Index |
| <kbd>Ctrl</kbd> + <kbd>h</kbd> | Open Query History |
| <kbd>Ctrl</kbd> + <kbd>Backspace</kbd> | Back to Previous Directory |
| <kbd>Esc</kbd> | Back to results / hide search window |
| <kbd>Ctrl</kbd> +<kbd>C</kbd> | Copy the actual folder / file |
| <kbd>Ctrl</kbd> +<kbd>I</kbd> | Open Settings window |
| <kbd>F5</kbd> | Reload all plugin data |
| <kbd>Ctrl</kbd> + <kbd>H</kbd> | Open search history |
| <kbd>Ctrl</kbd> + <kbd>Backspace</kbd> | Back to previous directory |


## System Command List
Expand Down Expand Up @@ -263,13 +265,9 @@ Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launc

## Development

### Status

Flow is under heavy development, but the code base is stable, so contributions are very welcome. If you would like to help maintain it, please do not hesistate to get in touch.

### Contributing

We welcome all contributions. If you are unsure of a change you want to make, let us know in the [Discussions](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/ideas), otherwise feel free to put in a pull request.
Contributions are very welcome, in addition to the main project(C#) there are also [documentation](https://github.com/Flow-Launcher/docs)(md), [website](https://github.com/Flow-Launcher/flow-launcher.github.io)(html/css) and [others](https://github.com/Flow-Launcher) that can be contributed to. If you are unsure of a change you want to make, let us know in the [Discussions](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/ideas), otherwise feel free to put in a pull request.

You will find the main goals of flow placed under the [Projects board](https://github.com/Flow-Launcher/Flow.Launcher/projects), so feel free to contribute on that. If you would like to make small incremental changes, feel free to do so as well.

Expand Down