README.md
    
    exported SGML document, ASCII text
Materia
Materia is a Material Design theme for GNOME/GTK based desktop environments.
It supports GTK 2, GTK 3, GTK 4, GNOME Shell, Budgie, Cinnamon, MATE, Unity, Xfce, LightDM, GDM, Chrome theme, etc.
Previews
Features
Supports ripple animations for GTK 3 and 4:
3 color variants and 2 size variants are available:
Materia | standard | compact :-: | :-: | :-: standard | ![Materia][1] | ![Materia-compact][2] dark | ![Materia-dark][3] | ![Materia-dark-compact][4] light | ![Materia-light][5] | ![Materia-light-compact][6]
[1]: images/Materia.png?raw=true [2]: images/Materia-compact.png?raw=true [3]: images/Materia-dark.png?raw=true [4]: images/Materia-dark-compact.png?raw=true [5]: images/Materia-light.png?raw=true [6]: images/Materia-light-compact.png?raw=true
Supported Toolkits and Desktops
GTK 2
GTK 3
>=3.20GTK 4
>=4.0Budgie
>=10.4Cinnamon
>=3.xGNOME Shell
>=3.26MATE
>=1.14Unity
>=7.4Xfce
>=4.13
Unsupported Apps and Desktops
elementary apps
Because they are based on their own stylesheet that conflicts with GTK standards.
Downstream customized GNOME sessions
E.g. "Ubuntu" session, "Pop" session. To properly use Materia on GNOME Shell, please install
gnome-sessionand then switch to "GNOME" or "GNOME on Xorg" session from your display manager.
Installation
Distro Packages
Distro | Package Name | Annotation
- | - | ---
Arch Linux | materia-gtk-theme | Link
Debian 10 or later | materia-gtk-theme | Link
Fedora | materia-gtk-theme | Link
Solus | materia-gtk-theme | Link
Ubuntu 18.04 or later | materia-gtk-theme | Link
NOTE: Distro packages could be outdated and incompatible with your desktop environment. You can check the latest version here.
Flatpak
All 6 variants are available via Flathub:
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
flatpak install flathub org.gtk.Gtk3theme.Materia{,-dark,-light}{,-compact}
Manual Installation
See INSTALL.md for details.
Recommendations
Font
Use a font family including Medium weight (e.g. Roboto or M+) to properly display the theme.
Set the font size to
9.75(= 13px at 96dpi) or10.5(= 14px at 96dpi).
Chrome Extensions
To improve the appearance of Chrome, you can install our Chrome extensions as follows:
Open the
/usr/share/themes/Materia<-variant>/chromefolder in your file manager.Drag and drop the
.crxfiles into the Chrome's Extensions page (chrome://extensions).
GDM Theme
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
See INSTALL_GDM_THEME.md for details.
Customization
Materia can be customized with GUI application, oomox theme designer.
Materia also allows you to change the color scheme relatively easily in other ways. See HACKING.md for details.
Contributing
If you find bugs or have suggestions, please report it to the issue tracker. Any contribution would be much appreciated.
Todo list can be found at TODO.md.
Related Projects
Materia KDE by @PapirusDevelopmentTeam
Materia VSCode Theme by @m-thorsen
Materia Kolorizer by @DarthWound
oomox theme designer by @themix-project
License
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the COPYING file for details.
Acknowledgments
Materia is based on Adwaita by GNOME.
Design and specifications are based on Google's Material Design.
The included symbolic icons are based on Material Design icons by Google.
The Chrome scrollbar extension was forked from Adwaita-chrome-scrollbar by GNOME Integration Team.
Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with oomox.
@n3oxmind who helped improve the installation script we had.
@smurphos who made and provided the Cinnamon theme for Materia.
Our Meson code is heavily influenced by @monday15's lounge-gtk-theme.
Also thank you to all contributors and upstream developers.
                
                    1
                    <img src="images/materia-logo.svg" alt="materia-logo" align="right" /> 
                
                    2
                     
                
                    3
                    # Materia 
                
                    4
                     
                
                    5
                    Materia is a [Material Design](https://material.io) theme for GNOME/GTK based desktop environments. 
                
                    6
                     
                
                    7
                    It supports GTK 2, GTK 3, GTK 4, GNOME Shell, Budgie, Cinnamon, MATE, Unity, Xfce, LightDM, GDM, Chrome theme, etc. 
                
                    8
                     
                
                    9
                    ## Previews 
                
                    10
                     
                
                    11
                     
                
                    12
                     
                
                    13
                     
                
                    14
                    ## Features 
                
                    15
                     
                
                    16
                    Supports **ripple animations** for GTK 3 and 4: 
                
                    17
                     
                
                    18
                     
                
                    19
                     
                
                    20
                    **3 color variants** and **2 size variants** are available: 
                
                    21
                     
                
                    22
                    **Materia** | **standard** | **compact** 
                
                    23
                    :-: | :-: | :-: 
                
                    24
                    **standard** | ![Materia][1] | ![Materia-compact][2] 
                
                    25
                    **dark** | ![Materia-dark][3] | ![Materia-dark-compact][4] 
                
                    26
                    **light** | ![Materia-light][5] | ![Materia-light-compact][6] 
                
                    27
                     
                
                    28
                    [1]: images/Materia.png?raw=true 
                
                    29
                    [2]: images/Materia-compact.png?raw=true 
                
                    30
                    [3]: images/Materia-dark.png?raw=true 
                
                    31
                    [4]: images/Materia-dark-compact.png?raw=true 
                
                    32
                    [5]: images/Materia-light.png?raw=true 
                
                    33
                    [6]: images/Materia-light-compact.png?raw=true 
                
                    34
                     
                
                    35
                    ## Supported Toolkits and Desktops 
                
                    36
                     
                
                    37
                    - GTK 2 
                
                    38
                    - GTK 3 `>=3.20` 
                
                    39
                    - GTK 4 `>=4.0` 
                
                    40
                    - Budgie `>=10.4` 
                
                    41
                    - Cinnamon `>=3.x` 
                
                    42
                    - GNOME Shell `>=3.26` 
                
                    43
                    - MATE `>=1.14` 
                
                    44
                    - Unity `>=7.4` 
                
                    45
                    - Xfce `>=4.13` 
                
                    46
                     
                
                    47
                    ## Unsupported Apps and Desktops 
                
                    48
                     
                
                    49
                    - elementary apps 
                
                    50
                      > Because they are based on [their own stylesheet](https://github.com/elementary/stylesheet) that conflicts with GTK standards. 
                
                    51
                    - Downstream customized GNOME sessions 
                
                    52
                      > E.g. "Ubuntu" session, "Pop" session. To properly use Materia on GNOME Shell, please install `gnome-session` and then switch to "GNOME" or "GNOME on Xorg" session from your display manager. 
                
                    53
                     
                
                    54
                    ## Installation 
                
                    55
                     
                
                    56
                    ### Distro Packages 
                
                    57
                     
                
                    58
                    <!-- For contributors, please add your package alphabetically. --> 
                
                    59
                     
                
                    60
                    Distro | Package Name | Annotation 
                
                    61
                    --- | --- | --- 
                
                    62
                    Arch Linux | `materia-gtk-theme` | [Link](https://www.archlinux.org/packages/community/any/materia-gtk-theme/) 
                
                    63
                    Debian 10 or later | `materia-gtk-theme` | [Link](https://packages.debian.org/materia-gtk-theme) 
                
                    64
                    Fedora | `materia-gtk-theme` | [Link](https://src.fedoraproject.org/rpms/materia-gtk-theme) 
                
                    65
                    Solus | `materia-gtk-theme` | [Link](https://dev.getsol.us/source/materia-gtk-theme/) 
                
                    66
                    Ubuntu 18.04 or later | `materia-gtk-theme` | [Link](https://packages.ubuntu.com/materia-gtk-theme) 
                
                    67
                     
                
                    68
                    > NOTE: Distro packages could be outdated and incompatible with your desktop environment. You can check the latest version [here](https://github.com/nana-4/materia-theme/releases). 
                
                    69
                     
                
                    70
                    ### Flatpak 
                
                    71
                     
                
                    72
                    All 6 variants are available via Flathub: 
                
                    73
                     
                
                    74
                    ``` 
                
                    75
                    flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo 
                
                    76
                    flatpak install flathub org.gtk.Gtk3theme.Materia{,-dark,-light}{,-compact} 
                
                    77
                    ``` 
                
                    78
                     
                
                    79
                    ### Manual Installation 
                
                    80
                     
                
                    81
                    See [`INSTALL.md`](INSTALL.md) for details. 
                
                    82
                     
                
                    83
                    ## Recommendations 
                
                    84
                     
                
                    85
                    ### Font 
                
                    86
                     
                
                    87
                    - Use a font family including **Medium** weight (e.g. [Roboto](https://github.com/google/roboto) or [M+](https://mplus-fonts.osdn.jp)) to properly display the theme. 
                
                    88
                    - Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi). 
                
                    89
                     
                
                    90
                    ### Chrome Extensions 
                
                    91
                     
                
                    92
                    To improve the appearance of Chrome, you can install our Chrome extensions as follows: 
                
                    93
                     
                
                    94
                    1. Open the `/usr/share/themes/Materia<-variant>/chrome` folder in your file manager. 
                
                    95
                    2. Drag and drop the `.crx` files into the Chrome's Extensions page (`chrome://extensions`). 
                
                    96
                     
                
                    97
                    ### GDM Theme 
                
                    98
                     
                
                    99
                    You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.   
                
                    100
                    See [`INSTALL_GDM_THEME.md`](INSTALL_GDM_THEME.md) for details. 
                
                    101
                     
                
                    102
                    ## Customization 
                
                    103
                     
                
                    104
                    Materia can be customized with GUI application, [**oomox theme designer**](https://github.com/themix-project/oomox). 
                
                    105
                     
                
                    106
                    Materia also allows you to change the color scheme relatively easily in other ways. See [`HACKING.md`](HACKING.md#how-to-change-the-color-scheme) for details. 
                
                    107
                     
                
                    108
                    ## Contributing 
                
                    109
                     
                
                    110
                    If you find bugs or have suggestions, please report it to the [issue tracker](https://github.com/nana-4/materia-theme/issues). Any contribution would be much appreciated. 
                
                    111
                     
                
                    112
                    Todo list can be found at [`TODO.md`](TODO.md). 
                
                    113
                     
                
                    114
                    ## Related Projects 
                
                    115
                     
                
                    116
                    - [**Materia KDE**](https://github.com/PapirusDevelopmentTeam/materia-kde) by @PapirusDevelopmentTeam 
                
                    117
                    - [**Materia VSCode Theme**](https://marketplace.visualstudio.com/items?itemName=m-thorsen.vscode-materia) by @m-thorsen 
                
                    118
                    - [**Materia Kolorizer**](https://github.com/DarthWound/materia-kolorizer) by @DarthWound 
                
                    119
                    - [**oomox theme designer**](https://github.com/themix-project/oomox) by @themix-project 
                
                    120
                     
                
                    121
                    ## License 
                
                    122
                     
                
                    123
                    Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details. 
                
                    124
                     
                
                    125
                    ## Acknowledgments 
                
                    126
                     
                
                    127
                    - Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME. 
                
                    128
                    - Design and specifications are based on Google's [Material Design](https://material.io). 
                
                    129
                    - The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google. 
                
                    130
                    - The Chrome scrollbar extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team. 
                
                    131
                    - Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/themix-project/oomox). 
                
                    132
                    - @n3oxmind who helped improve the installation script we had. 
                
                    133
                    - @smurphos who made and provided the Cinnamon theme for Materia. 
                
                    134
                    - Our Meson code is heavily influenced by @monday15's [lounge-gtk-theme](https://github.com/monday15/lounge-gtk-theme). 
                
                    135
                     
                
                    136
                    Also thank you to all contributors and upstream developers. 
                
                    137