Skip to content
This repository was archived by the owner on Oct 15, 2025. It is now read-only.

Commit dd2d795

Browse files
Update readme
1 parent 806da15 commit dd2d795

1 file changed

Lines changed: 5 additions & 17 deletions

File tree

README.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,11 @@
11
## Official Albert Python plugin repository
22

3-
This repository is shipped with Albert. Credits go to our contributors 👍
3+
These plugins are shipped with the app.
4+
5+
Visit the website to learn [how to write plugins](https://albertlauncher.github.io/gettingstarted/extension/).
6+
7+
Credits go to our contributors:
48

59
<a href = "https://github.com/albertlauncher/python/graphs/contributors">
610
<img src = "https://contrib.rocks/image?repo=albertlauncher/python"/>
711
</a>
8-
9-
### Contribution
10-
11-
* Fork this repository.
12-
* Clone it into the Python user plugin location.
13-
```shell
14-
# on linux
15-
git clone https://github.com/<username>/python.git ~/.local/share/albert/python/plugins
16-
17-
# on macos
18-
git clone https://github.com/<username>/python.git ~/Library/Application\ Support/albert/python/plugins
19-
```
20-
* Open the directory in your favorite IDE (PyCharmCE is a good choice).
21-
* The Python plugins plugin installs a python stub file in your user plugin directory. This file serves as API documentation and gives you coding assistance if you are using a decent IDE.
22-
* Write your plugin. Make sure it is polished (No bugs, few to no linting warnings, efficient, readable, maintainable, …).
23-
* Commit, push, send a PR.

0 commit comments

Comments
 (0)