Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.83 KB

INSTALL.md

File metadata and controls

59 lines (36 loc) · 1.83 KB
Raw

extensions.gnome.org

The easiest way to install the extension is to go to extensions.gnome.org.

However, the review process on extensions.gnome.org is sometimes slow. A new release may be available here on GitHub, but not on extensions.gnome.org yet.

Install from a package

You can also install the extension from a .zip package.

1. Obtain the package

You could either download an already-built package or build it from the source code yourself.

1.a) Prebuilt package

You can download a released version from Releases page. You need the file [email protected].

Also, the CI system builds a package for every commit. The package is attached as an artifact called pack. Due to GitHub Actions limitations, it's a zip archive within a zip archive - unzip pack.zip to get [email protected].

1.b) Build from source code

See BUILD.md for build instructions.

2. Install the package

After downloading or building the package, run the following command to install it:

$ gnome-extensions install -f /path/to/[email protected]

3. Restart GNOME Shell

To detect the newly installed or upgraded extension, GNOME Shell usually needs to be restarted.

On Wayland, the only way is to restart your session - log out, then login back.

On X11 you can restart the shell without logging out by pressing Alt+F2, r, Enter.

4. Enable the extension

After GNOME Shell had been restarted, you can enable the extension using the gnome-tweaks app, or by running:

$ gnome-extensions enable [email protected]

You'll have to perform this step only once.