Skip to content

Commit 4a79bd7

Browse files
committed
Add Installation, Contributing and Developing sections to the readme
Resolves #34
1 parent d02b408 commit 4a79bd7

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[<img src="https://raw.githubusercontent.com/andyholmes/gnome-shell-extensions-badge/master/get-it-on-ego.svg?sanitize=true" height="100" align="right">](https://extensions.gnome.org/extension/1485/workspace-matrix/)
2-
31
# Workspace Matrix
42

53
GNOME shell extension to arrange workspaces in a two dimensional grid with workspace thumbnails.
@@ -18,3 +16,27 @@ This is a clone of the [Workspace Grid](https://github.com/zakkak/workspace-grid
1816
- Configurable timeout of the workspace switcher popup.
1917
- Two wraparound modes for navigating workspaces (optional).
2018
- Workspace labels in the workspace switcher popup (optional).
19+
20+
## Installation
21+
22+
[<img src="https://raw.githubusercontent.com/andyholmes/gnome-shell-extensions-badge/master/get-it-on-ego.svg?sanitize=true" height="100">](https://extensions.gnome.org/extension/1485/workspace-matrix/)
23+
24+
The easiest way to install this extension is via the [GNOME Extensions](https://extensions.gnome.org/extension/1485/workspace-matrix/) website.
25+
26+
## Contributing
27+
28+
Pull requests for issues that are marked as "bug" or "help wanted" are always welcome. If you want to implement any other new feature, please open an issue about this first. See the next section on how to get started with development.
29+
30+
## Developing
31+
32+
You can develop this extension "live" while it is installed in GNOME on your system:
33+
34+
1. Uninstall this extension if it is already installed. You can do this via the [GNOME Extensions](https://extensions.gnome.org/extension/1485/workspace-matrix/) website.
35+
2. Clone this repository somewhere, e.g. to `~/code/gnome-shell-workspace-matrix`.
36+
3. Create a symlink from this repository to the GNOME extensions directory, e.g.:
37+
```
38+
ln -s ~/code/gnome-shell-workspace-matrix/wsmatrix@martin.zurowietz.de ~/.local/share/gnome-shell/extensions/gnome-shell-workspace-matrix/wsmatrix@martin.zurowietz.de
39+
```
40+
4. Restart GNOME by pressing Alt+F2 and running the command `r`. Do this whenever you want to apply and test a change of the code.
41+
42+
If you change something in the gschema XML file, run `make` to recompile it. The `make` command also builds the ZIP file that can be used for new releases of this extension.

0 commit comments

Comments
 (0)