Skip to content

Commit 5634aa7

Browse files
authored
Merge pull request #501 from Flow-Launcher/update_readme
Update README.md
2 parents 26a37c0 + 6306da7 commit 5634aa7

File tree

2 files changed

+34
-25
lines changed

2 files changed

+34
-25
lines changed

README.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be
1616

1717
<sub>Remember to star it, flow will love you more :)</sub>
1818

19+
---
20+
21+
<h4 align="center">
22+
<a href="#Features">Features</a> •
23+
<a href="#Getting-Started">Getting Started</a> •
24+
<a href="#QuestionsSuggestions">Questions/Suggestions</a> •
25+
<a href="#Development">Development</a> •
26+
<a href="https://flow-launcher.github.io/docs">Documentation</a>
27+
</h4>
28+
29+
---
30+
1931
## Features
2032

2133
![The Flow](https://user-images.githubusercontent.com/26427004/82151677-fa9c7100-989f-11ea-9143-81de60aaf07d.gif)
@@ -33,7 +45,9 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be
3345

3446
[<img width="12px" src="https://user-images.githubusercontent.com/26427004/104119722-9033c600-5385-11eb-9d57-4c376862fd36.png"> **SOFTPEDIA EDITOR'S PICK**](https://www.softpedia.com/get/System/Launchers-Shutdown-Tools/Flow-Launcher.shtml)
3547

36-
## Running Flow Launcher
48+
## Getting Started
49+
50+
### Installation
3751

3852
| [Windows 7 and up installer](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) | `WinGet install "Flow Launcher"` |
3953
| -------------------------------------------------------------------------------------------- | -------------------------------- |
@@ -52,45 +66,40 @@ Windows may complain about security due to code not being signed, this will be c
5266

5367
[More tips](https://flow-launcher.github.io/docs/#/usage-tips)
5468

55-
### Integrations
56-
- If you use Python plugins:
57-
- Install [Python3](https://www.python.org/downloads/), download `.exe` installer.
58-
- Add Python to `%PATH%` or set it in flow's settings.
59-
- Use `pip` to install `flowlauncher`, open cmd and type `pip install flowlauncher`.
60-
- The Python plugin may require additional modules to be installed, please ensure you check by visiting the plugin's website via `pm install` + plugin name, go to context menu and select `Open website`.
61-
- Start to launch your Python plugins.
62-
- Flow searches files and contents via Windows Index Search, to use Everything: `pm install everything`.
69+
### Plugins
6370

64-
## Plugins
71+
Flow searches files and contents via Windows Index Search, to use **Everything**: `pm install everything`.
6572

66-
There is a [list of actively maintained plugins](https://github.com/Flow-Launcher/docs/blob/main/plugins.md) in the documentation section, some of which are integrated from other launchers.
73+
If you are using Python plugins, flow will prompt to either select the location or allow Python (Embeddable) to be automatic downloaded for use.
6774

68-
## Status
75+
Vist [here](https://flow-launcher.github.io/docs/#/plugins) for our plugin portfolio.
6976

70-
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.
77+
If you are keen to write your own plugin for flow, please take a look at our plugin development documentation for [C#](https://flow-launcher.github.io/docs/#/develop-csharp-plugins) or [Python](https://flow-launcher.github.io/docs/#/develop-py-plugins)
7178

72-
## Contributing
79+
## Questions/Suggestions
7380

74-
We welcome all contributions. If you are unsure of a change you want to make, simply put an issue in for discussion, otherwise feel free to put in a pull request.
81+
Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/q-a) section.
7582

76-
You will find the main goals of flow placed under Projects board, so feel free to contribute on that. If you would like to make small incremental changes, feel free to do so as well.
83+
**Join our community on [Discord](https://discord.gg/AvgAQgh)!**
7784

78-
Get in touch if you like to join the Flow-Launcher Team and help build this great tool.
85+
## Development
7986

80-
## Question/Suggestion
87+
### Status
8188

82-
Yes please, submit an issue to let us know.
89+
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.
8390

84-
**Join our community on [Discord](https://discord.gg/AvgAQgh)!**
91+
### Contributing
92+
93+
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.
8594

86-
## Developing/Debugging
95+
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.
96+
97+
Get in touch if you like to join the Flow-Launcher Team and help build this great tool.
98+
99+
### Developing/Debugging
87100

88101
Flow Launcher's target framework is .Net 5
89102

90103
Install Visual Studio 2019
91104

92105
Install .Net 5 SDK via Visual Studio installer or manually from [here](https://dotnet.microsoft.com/download/dotnet/thank-you/sdk-5.0.103-windows-x64-installer)
93-
94-
## Documentation
95-
96-
Visit [here](https://flow-launcher.github.io/docs) for more information on usage, development and design documentations

0 commit comments

Comments
 (0)