README.md 1.3 KB
Newer Older
Carlos Soriano's avatar
Carlos Soriano committed
1
# Desktop Icons
2 3 4

## What  is it

Carlos Soriano's avatar
Carlos Soriano committed
5 6
A GNOME Shell extension for providing desktop icons.

7 8
## Requirements

9 10
* GNOME Shell >= 3.30
* Nautilus >= 3.30.4
11
* xdg-desktop-portal-gtk
12

13 14
## How to contribute

15 16
* Download the code
* Build with Meson (see at the next section)
Carlos Soriano's avatar
Carlos Soriano committed
17
* Log out & log in from your user session. Alternatively, just restart the computer.
Carlos Soriano's avatar
Carlos Soriano committed
18 19
* Activate the extension in GNOME Tweaks

20
## Build with Meson
21

22 23
The project uses a build system called [Meson](https://mesonbuild.com/). You can install
in most Linux distributions as "meson".
24

Carlos Soriano's avatar
Carlos Soriano committed
25 26 27 28
It's possible to read more information in the Meson docs to tweak the configuration if needed.

For a regular use and local development these are the steps to build the
project and install it:
29 30

```bash
31
meson --prefix=$HOME/.local/ --localedir=share/gnome-shell/extensions/desktop-icons@csoriano/locale .build
32
ninja -C .build install
33
```
34

35 36 37 38
It is strongly recommended to delete the destination folder
($HOME/.local/share/gnome-shell/extensions/desktop-icons@csoriano) before doing this, to ensure that no old
data is kept.

39 40 41
## Export extension ZIP file for extensions.gnome.org

To create a ZIP file with the extension, just run:
42 43

```bash
44 45
./export-zip.sh
```
46 47 48

This will create the file `desktop-icons@csoriano.zip` with the extension, following the rules for publishing
at extensions.gnome.org.