Skip to content

Commit c4c342d

Browse files
committed
chore(readme): Document plugins and scripts
1 parent d6e8d05 commit c4c342d

File tree

3 files changed

+24
-10
lines changed

3 files changed

+24
-10
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Therefore, we see an opportunity here to advance the usability of the GNOME desk
1919
- [Shared Features](#shared-features): Behaviors shared between stacking and auto-tiling modes
2020
- [Stacking Mode](#stacking-mode): Behaviors specific to the stacking mode
2121
- [Auto-Tile Mode](#auto-tile-mode): Behaviors specific to the auto-tiling mode
22+
- [Plugins](#plugins): Details about plugins and development
2223
- [Developers](#developers): Guide for getting started with development
2324
---
2425

@@ -147,13 +148,6 @@ By default, the launcher searches windows and applications. However, you can des
147148
- `=`: Calculator mode, powered by [MathJS](https://mathjs.org/)
148149
- `/` | `~`: Navigate and open directories and files in the file system
149150
- `d`: Search recent documents
150-
### Launcher Plugins
151-
152-
Pop Shell supports extending the functionality of its launcher, and comes with some plugins by default.
153-
154-
155-
156-
For plugin developers, see [the API documentation for the launcher API](src/plugins/README.md).
157151

158152
### Inner and Outer Gaps
159153

@@ -215,6 +209,26 @@ For example, doing `xprop` on GNOME Settings (or GNOME Control Center), the WM_C
215209

216210
After applying changes in the `config.json`, you can reload the tiling if it doesnt work the first time.
217211

212+
## Plugins
213+
214+
### Launcher Plugins
215+
216+
Pop Shell supports extending the functionality of its launcher, and comes with some plugins by default. System plugins are stored in `/usr/lib/pop-shell/launcher/`, while user plugins are stored in `$HOME/.local/share/pop-shell/launcher/`. Some plugins are included by default:
217+
218+
- [calc](src/plugins/calc)
219+
- [files](src/plugins/files)
220+
- [pulse](src/plugins/pulse)
221+
- [recent](src/plugins/recent)
222+
- [terminal](src/plugins/terminal)
223+
- [web](src/plugins/web)
224+
- [scripts](src/plugin_scripts.ts)
225+
226+
> Plugin developers, see [the API documentation for the launcher API](src/plugins/README.md).
227+
228+
### Scripts Plugin
229+
230+
This builtin plugin displays scripts in search results. Included with Pop Shell is a set of scripts for log out, reboot, and power off. Scripts are stored in `/usr/lib/pop-shell/scripts/` and `$HOME/.local/share/pop-shell/scripts/`. [See the included scripts as an example of how to create our own](src/scripts/).
231+
218232
## Developers
219233

220234
Due to the risky nature of plain JavaScript, this GNOME Shell extension is written in [TypeScript](https://www.typescriptlang.org/). In addition to supplying static type-checking and self-documenting classes and interfaces, it allows us to write modern JavaScript syntax whilst supporting generation of code for older targets.

debian/control

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Standards-Version: 3.9.8
77
Homepage: https://github.com/pop-os/shell
88
Vcs-Git: https://github.com/pop-os/shell
99

10-
Package: pop-shell-plugins-system76-power
10+
Package: pop-shell-plugin-system76-power
1111
Architecture: all
1212
Depends: pop-shell, system76-power
1313
Description: Launcher integration with system76-power
@@ -17,7 +17,7 @@ Architecture: all
1717
Depends:
1818
${misc:Depends},
1919
pop-shell-shortcuts
20-
Recommends: pop-shell-plugins-system76-power
20+
Recommends: pop-shell-plugin-system76-power
2121
Replaces: gnome-control-center-data (<< 1:3.38.1-2ubuntu1pop1~)
2222
Breaks: gnome-control-center-data (<< 1:3.38.1-2ubuntu1pop1~)
23-
Description: Pop!_OS Shell
23+
Description: Pop!_OS Shell

0 commit comments

Comments
 (0)