Skip to content

Commit 8746960

Browse files
committed
Main update
1 parent 82806ed commit 8746960

File tree

11 files changed

+107
-17
lines changed

11 files changed

+107
-17
lines changed

.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"cSpell.ignoreWords": [
3+
"flowlauncher"
4+
]
5+
}

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
## Welcome
22

3-
Here you will find documentation on usage tips, design information, plugin development, and more.
4-
5-
If you have just started using Flow, please head over to the [Usage Tips](/usage-tips.md) section to find out how you can get the most out of Flow. Otherwise, if you are completely new to Flow and want to find out its features and give it a spin, please visit [here](https://github.com/Flow-Launcher/Flow.Launcher/#-features).
3+
If you have just started using Flow, this documentation should help familiarise you with how to get to the the settings to customise Flow to your liking, show you some usage tips to use Flow more effectively, as well as provide more detailed documentation for plugin authors.

_sidebar.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
- [**Introduction**](/README.md)
2+
- [**Installation**](/installation.md)
3+
- [**Settings**](/settings.md)
24
- [**Usage Tips**](/usage-tips.md)
5+
- [**Support**](/support.md)
36
- [**Plugin Directory**](/plugins.md)
47
- [**Explorer Plugin**](/plugin-explorer-usage.md)
5-
- Plugin Development
6-
- [**Get Started**](/plugin-dev.md)
8+
- [**Plugin Development**](/plugin-dev.md)
79
- [**plugin.json**](/plugin.json.md)
810
- Dotnet Plugins
911
- [**Development Guide**](/develop-dotnet-plugins.md)

assets/Flow_settings_launch.png

46.9 KB
Loading
40.8 KB
Loading

assets/Flow_settings_taskbar.png

16.9 KB
Loading

assets/Flow_smartscreen.png

13 KB
Loading

installation.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
### Installation
2+
3+
Flow Launcher can be installed several ways, including Windows package managers Winget, Scoop and Chocolatey. The most popular method is to download the installer file from the main Flow Launcher website. This downloads the latest release package from the Flow Launcher Github repository (repo).
4+
5+
#### Security
6+
7+
When installing Flow Launcher, you will get the Microsoft Defender SmartScreen installer window warning:
8+
9+
![MS SmartScreen install warning](/assets/Flow_smartscreen.png)
10+
11+
This appears as Flow Launcher has not been downloaded enough times, or users have not flagged this as "safe", for Microsoft to yet allow the installer to run without this warning. Over time we are hoping this becomes a trusted app with Microsoft, however this does not mean Flow Launcher is dangerous or malicious. As you should do with all software, you should be satisfied of the pedigree of of the installation executable. For Flow Launcher you should ensure you download from flowlauncher.com, or the official repo. Flow Launcher is open source so anyone can download and review the source code. Any issues or concerns are welcome in the Issues part of the repo.
12+
13+
You may also get false positives from third party anti-virus and anti-malware applications. As above, once you are sure you have downloaded the installer from an official source, and asked any questions you have with GitHub Issues, we ask that you submit a false-positive report to the AV vendor.
14+
15+
#### Plugins
16+
17+
Flow Launcher installs with a set of "core" plugins that are maintained by the Flow Launcher team. These are:
18+
19+
- Browser Bookmarks
20+
- Calculator
21+
- Explorer
22+
- Plugin Indicator
23+
- Plugins Manager
24+
- Process Killer
25+
- Program
26+
- Shell
27+
- System Commands
28+
- URL
29+
- Web Searches
30+
- Window Settings
31+
32+
There are also over 200 third party plugins that extend Flow Launcher's functionality and these can be browsed and installed in the Plugin Store settings page

settings.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Settings
2+
3+
The settings allow you to configure and customise Flow and its plugins, and gives visual access to the Plugin Store.
4+
5+
6+
Settings can be accessed three ways:
7+
8+
1. Type `settings` in the Flow Launcher search bar and choose "Tweak Flow Launcher's settings".
9+
10+
![Settings via search bar](/assets/Flow_settings_launch.png)
11+
12+
2. Right-click on the Flow Launcher taskbar icon and choose "Settings".
13+
14+
![Settings via taskbar](/assets/Flow_settings_taskbar.png)
15+
16+
3. Activate Flow Launcher and right-click anywhere in the search bar and choose "Settings".
17+
18+
![Settings via search bar right-click](/assets/Flow_settings_launch_right_click.png)
19+

support.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Support
2+
3+
Flow Launcher is an open source project that is updated and maintained by a team of volunteers. If you have any issues or questions, the Flow Launcher team and other users can help in the following ways:
4+
5+
- For any errors or bug reports raise an issue in the GitHib Repository. Please follow the new issue template and try and describe in as much detail as you can what you were doing when the error occurred. If it is determined the error is with a third party plugin, you may be directed to open the issue in the plugin author's repository so they can investigate.
6+
7+
https://github.com/Flow-Launcher/Flow.Launcher/issues
8+
9+
- For problems, suggestions, hints, tips, help with plugin dev, or just to connect with other Flow Launcher users world-wide, pop in and say hello on
10+
11+
Discord
12+
13+
https://discord.gg/AvgAQgh
14+
15+
or Reddit
16+
17+
https://www.reddit.com/r/FlowLauncher/

0 commit comments

Comments
 (0)