INSTALL.md

                
                    
1
                    ## Installation from source
                
                    
2
                    
                
                    
3
                    ### Dependencies
                
                    
4
                    
                
                    
5
                    Materia requires the following build and runtime dependencies:
                
                    
6
                    
                
                    
7
                    #### Build dependencies
                
                    
8
                    
                
                    
9
                    - `meson` >= 0.47.0
                
                    
10
                    - `dart-sass` >= 1.23.0 (or `npm` if the former is not found)
                
                    
11
                    
                
                    
12
                    #### Runtime dependencies
                
                    
13
                    
                
                    
14
                    - `gnome-themes-extra` (or `gnome-themes-standard` for older distributions)
                
                    
15
                    - Murrine engine — The package name depends on the distro:
                
                    
16
                      - `gtk-engine-murrine` on Arch Linux
                
                    
17
                      - `gtk-murrine-engine` on Fedora
                
                    
18
                      - `gtk2-engine-murrine` on openSUSE
                
                    
19
                      - `gtk2-engines-murrine` on Debian, Ubuntu, etc.
                
                    
20
                    
                
                    
21
                    ### Steps to install
                
                    
22
                    
                
                    
23
                    1. Clone the repository and move into the project directory in terminal:
                
                    
24
                    
                
                    
25
                    ```sh
                
                    
26
                    git clone https://github.com/nana-4/materia-theme
                
                    
27
                    cd materia-theme
                
                    
28
                    ```
                
                    
29
                    
                
                    
30
                    2. Configure the project using Meson (you can optionally set build options [as below](#build-options)):
                
                    
31
                    
                
                    
32
                    ```sh
                
                    
33
                    meson _build
                
                    
34
                    ```
                
                    
35
                    
                
                    
36
                    3. Build and install it using Meson:
                
                    
37
                    
                
                    
38
                    ```sh
                
                    
39
                    meson install -C _build
                
                    
40
                    ```
                
                    
41
                    
                
                    
42
                    ### Build options
                
                    
43
                    
                
                    
44
                    Option | Default Value | Description
                
                    
45
                    --- | --- | ---
                
                    
46
                    `prefix` | `/usr` | Installation prefix
                
                    
47
                    `colors` | `default,light,dark` | List of color variants to build
                
                    
48
                    `sizes` | `default,compact` | List of size variants to build
                
                    
49
                    `gnome_shell_version` | n/a (auto) | Build GNOME Shell theme for specific version
                
                    
50
                    `gtk4_version` | n/a (auto) | Build GTK 4 theme for specific version
                
                    
51
                    
                
                    
52
                    Build options can be set at the configuration time, for example:
                
                    
53
                    
                
                    
54
                    ```sh
                
                    
55
                    meson _build -Dprefix="$HOME/.local" -Dcolors=default,dark -Dsizes=compact
                
                    
56
                    ```
                
                    
57
                    
                
                    
58
                    > Note: If you are a package maintainer, you should always set `gnome_shell_version` and `gtk4_version` in your package script based on the `gnome-shell` and `gtk4` package versions in your distribution. Otherwise, the corresponding themes may be built for wrong versions.
                
                    
59
                    
                
                    
60
                    ## Uninstallation
                
                    
61
                    
                
                    
62
                    Delete the installed directories:
                
                    
63
                    
                
                    
64
                    ```sh
                
                    
65
                    sudo rm -rf /usr/share/themes/Materia{,-dark,-light}{,-compact}
                
                    
66
                    ```
                
                    
67