README.md
ASCII text
Charta
Charta is a theme for GTK-based desktop environments, forked from Materia. It is inspired from the old Material Design (not Material 3, which is very different).
It supports GTK 2, GTK 3, GTK 4, GNOME Shell, Budgie, Cinnamon, MATE, Unity and Xfce.
Previews
Features
Supports ripple animations for GTK 3 and 4:
3 color variants and 2 size variants are available: standard, dark and light, each with a compact option.
More colour options will be coming soon, including a more traditional dark theme.
Supported Toolkits and Desktops
GTK 2
GTK 3
>=3.20
GTK 4
>=4.0
Budgie
>=10.4
Cinnamon
>=3.x
GNOME Shell
>=3.26
MATE
>=1.14
Unity
>=7.4
Xfce
>=4.13
Unsupported Apps and Desktops
elementary apps
Because they are based on their own stylesheet that conflicts with GTK standards.
Downstream customised GNOME sessions
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.libAdwaita apps
Because they only actually support GNOME. Many widgets do look correct in libAdwaita, but more work is needed, and a patch for libAdwaita to allow changing the theme.
Installation
There are currently no distro packages or Flatpaks. If anyone is interested in maintaining some, contact me.
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).
Customisation
The colour scheme can be modified relatively easily, as in Materia. See HACKING.md
for details.
Contributing
If you find bugs or have suggestions, please report them to the issue tracker. Any contribution would be much appreciated.
Todo list can be found at TODO.md
.
Related Projects
If you are porting the Charta theme to other applications, please let me know so I can add it here.
License
Charta, like Materia, is distributed under the terms of the GNU General Public License, version 2 or later. See the COPYING
file for details.
Acknowledgments
Charta is a recent fork of Materia by nana-4, which is in turn based on Adwaita, the default theme of GTK 3.
Design and specifications are based on Google's Material Design 1 and Material Design 2.
The various icons are based on Material Design icons by Google.
@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# Charta 4 5Charta is a theme for GTK-based desktop environments, forked from Materia. 6It is inspired from the old [Material Design](https://m2.material.io) 7(not Material 3, which is very different). 8 9It supports GTK 2, GTK 3, GTK 4, GNOME Shell, Budgie, Cinnamon, MATE, Unity 10and Xfce. 11 12## Previews 13 14 15 16 17## Features 18 19Supports **ripple animations** for GTK 3 and 4: 20 21 22 23**3 color variants** and **2 size variants** are available: standard, dark 24and light, each with a compact option. 25 26More colour options will be coming soon, including a more traditional dark 27theme. 28 29## Supported Toolkits and Desktops 30 31- GTK 2 32- GTK 3 `>=3.20` 33- GTK 4 `>=4.0` 34- Budgie `>=10.4` 35- Cinnamon `>=3.x` 36- GNOME Shell `>=3.26` 37- MATE `>=1.14` 38- Unity `>=7.4` 39- Xfce `>=4.13` 40 41## Unsupported Apps and Desktops 42 43* elementary apps 44> Because they are based on [their own stylesheet](https://github.com/elementary/stylesheet) that conflicts with GTK standards. 45* Downstream customised GNOME sessions 46> 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. 47* libAdwaita apps 48> Because they only actually support GNOME. Many widgets do look correct in libAdwaita, but more work is needed, and a patch for libAdwaita to allow changing the theme. 49 50## Installation 51 52There are currently no distro packages or Flatpaks. If anyone is interested in maintaining some, 53contact me. 54 55### Manual Installation 56 57See [`INSTALL.md`](INSTALL.md) for details. 58 59## Recommendations 60 61### Font 62 63* 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. 64* Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi). 65 66## Customisation 67 68The colour scheme can be modified relatively easily, as in Materia. See [`HACKING.md`](HACKING.md#how-to-change-the-color-scheme) for details. 69 70## Contributing 71 72If you find bugs or have suggestions, please report them to the [issue tracker](https://roundabout-host.com/roundabout/charta-gtk-theme). Any contribution would be much appreciated. 73 74Todo list can be found at [`TODO.md`](TODO.md). 75 76## Related Projects 77 78If you are porting the Charta theme to other applications, please let me know so I can add it here. 79 80## License 81 82Charta, like Materia, is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details. 83 84## Acknowledgments 85 86* Charta is a recent fork of [Materia](https://github.com/nana-4/materia-theme) 87by nana-4, which is in turn based on [Adwaita](HACKING.md#upstream-theme-sources), 88the default theme of GTK 3. 89* Design and specifications are based on Google's [Material Design 1](https://m1.material.io) 90and [Material Design 2](https://m2.material.io). 91* The various icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google. 92* @n3oxmind who helped improve the installation script we had. 93* @smurphos who made and provided the Cinnamon theme for Materia. 94* Our Meson code is heavily influenced by @monday15's [lounge-gtk-theme](https://github.com/monday15/lounge-gtk-theme). 95 96Also thank you to all contributors and upstream developers. 97