Skip to content

Commit

Permalink
chore(readme): Document plugins and scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
mmstick committed Dec 22, 2020
1 parent d6e8d05 commit c4c342d
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 10 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Therefore, we see an opportunity here to advance the usability of the GNOME desk
- [Shared Features](#shared-features): Behaviors shared between stacking and auto-tiling modes
- [Stacking Mode](#stacking-mode): Behaviors specific to the stacking mode
- [Auto-Tile Mode](#auto-tile-mode): Behaviors specific to the auto-tiling mode
- [Plugins](#plugins): Details about plugins and development
- [Developers](#developers): Guide for getting started with development
---

Expand Down Expand Up @@ -147,13 +148,6 @@ By default, the launcher searches windows and applications. However, you can des
- `=`: Calculator mode, powered by [MathJS](https://mathjs.org/)
- `/` | `~`: Navigate and open directories and files in the file system
- `d`: Search recent documents
### Launcher Plugins

Pop Shell supports extending the functionality of its launcher, and comes with some plugins by default.



For plugin developers, see [the API documentation for the launcher API](src/plugins/README.md).

### Inner and Outer Gaps

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

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

## Plugins

### Launcher Plugins

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:

- [calc](src/plugins/calc)
- [files](src/plugins/files)
- [pulse](src/plugins/pulse)
- [recent](src/plugins/recent)
- [terminal](src/plugins/terminal)
- [web](src/plugins/web)
- [scripts](src/plugin_scripts.ts)

> Plugin developers, see [the API documentation for the launcher API](src/plugins/README.md).
### Scripts Plugin

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/).

## Developers

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.
Expand Down
6 changes: 3 additions & 3 deletions debian/control
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Standards-Version: 3.9.8
Homepage: https://github.com/pop-os/shell
Vcs-Git: https://github.com/pop-os/shell

Package: pop-shell-plugins-system76-power
Package: pop-shell-plugin-system76-power
Architecture: all
Depends: pop-shell, system76-power
Description: Launcher integration with system76-power
Expand All @@ -17,7 +17,7 @@ Architecture: all
Depends:
${misc:Depends},
pop-shell-shortcuts
Recommends: pop-shell-plugins-system76-power
Recommends: pop-shell-plugin-system76-power
Replaces: gnome-control-center-data (<< 1:3.38.1-2ubuntu1pop1~)
Breaks: gnome-control-center-data (<< 1:3.38.1-2ubuntu1pop1~)
Description: Pop!_OS Shell
Description: Pop!_OS Shell

0 comments on commit c4c342d

Please sign in to comment.