HACKING.md
ASCII text
Summary
Do not edit the CSS directly, edit the source SCSS files and run
./parse-sass.shTo be able to use the latest/adequate version of Sass, install
sasscTo change the SVG assets color, use a text editor instead of a image editor
How to tweak the theme
Like the upstream Adwaita, this theme is written and processed in Sass.
You can read about Sass at http://sass-lang.com/documentation/. Once you make
your changes to the SCSS files, run the ./parse-sass.sh script to rebuild the
CSS files.
Here's a rundown of thesupporting stylesheets:
_variables.scss
variables to allow easier definition of widget sizing/styling.
_color-palette.scss
material design color palette definitions. We don't recommend editing this unless Google updates the color scheme.
_colors.scss
global color definitions. We keep the number of defined colors to a necessary minimum, most colors are derived from a handful of basics. It covers both the light variant and the dark variant.
_colors-public.scss
SCSS colors exported through gtk to allow for 3rd party apps color mixing.
_drawing.scss
drawing helper mixings/functions to allow easier definition of widget drawing under specific context.
_common.scss
actual definitions of style for each widget. This is where you are likely to add/remove your changes.
_apps.scssor_extensions.scss
app/extension specific stylings.
How to change the assets color
To keep it maintainable, SVG files are basically edited on text-based.
So if you just want to change the SVG assets color, we recommend using a text editor instead of Inkscape. However, please note that Inkscape is required to render the PNG assets from the SVG files.
Here's an example to change the _accent color_:
Open the following SVG files with a text editor.
- ./src/gtk-2.0/assets.svg
- ./src/gtk-2.0/assets-dark.svg
- ./src/gtk-3.0/gtk-common/assets.svg
- ./src/gnome-shell/3.18/assets/checkbox.svg
- ./src/gnome-shell/3.18/assets/more-results.svg
- ./src/gnome-shell/3.18/assets/toggle-on.svg
- ./src/gnome-shell/3.18/assets-dark/checkbox.svg
- ./src/gnome-shell/3.18/assets-dark/more-results.svg
- ./src/gnome-shell/3.18/assets-dark/toggle-on.svg
Search
#FF4081(default accent color) and replace with your favorite color.
- The recommended color palette is: https://material.io/guidelines/style/color.html#color-color-palette
For gtk2 and gtk3, delete all PNG assets before redrawing them.
sh
rm ./src/gtk-2.0/assets/*.png
rm ./src/gtk-2.0/assets-dark/*.png
rm ./src/gtk-3.0/gtk-common/assets/*.png
Run
./render-assets.shor./render-assets-dark.shto render the PNG assets.
> Note: Inkscape must be installed to run the scripts.
- for gtk2:
sh
cd ./src/gtk-2.0
./render-assets.sh
./render-assets-dark.sh
- for gtk3:
sh
cd ./src/gtk-3.0/gtk-common
./render-assets.sh
Useful Links
Upstream theme sources:
Tips:
1
Summary
2
-------
3
4
- Do not edit the CSS directly, edit the source SCSS files and run `./parse-sass.sh`
5
- To be able to use the latest/adequate version of Sass, install `sassc`
6
- To change the SVG assets color, use a text editor instead of a image editor
7
8
How to tweak the theme
9
----------------------
10
11
Like the upstream Adwaita, this theme is written and processed in Sass.
12
13
You can read about Sass at http://sass-lang.com/documentation/. Once you make
14
your changes to the SCSS files, run the `./parse-sass.sh` script to rebuild the
15
CSS files.
16
17
Here's a rundown of the _supporting_ stylesheets:
18
19
- `_variables.scss`
20
21
variables to allow easier definition of widget sizing/styling.
22
23
- `_color-palette.scss`
24
25
material design color palette definitions. We don't recommend editing this
26
unless Google updates the color scheme.
27
28
- `_colors.scss`
29
30
global color definitions. We keep the number of defined colors to a necessary
31
minimum, most colors are derived from a handful of basics. It covers both the
32
light variant and the dark variant.
33
34
- `_colors-public.scss`
35
36
SCSS colors exported through gtk to allow for 3rd party apps color mixing.
37
38
- `_drawing.scss`
39
40
drawing helper mixings/functions to allow easier definition of widget drawing
41
under specific context.
42
43
- `_common.scss`
44
45
actual definitions of style for each widget. This is where you are likely to
46
add/remove your changes.
47
48
- `_apps.scss` or `_extensions.scss`
49
50
app/extension specific stylings.
51
52
How to change the assets color
53
------------------------------
54
55
To keep it maintainable, SVG files are basically edited on text-based.
56
57
So if you just want to change the SVG assets color, we recommend using a
58
**text editor** instead of **Inkscape**. However, please note that Inkscape is
59
required to render the PNG assets from the SVG files.
60
61
Here's an example to change the _accent color_:
62
63
1. Open the following SVG files with a **text editor**.
64
65
- `./src/gtk-2.0/assets.svg`
66
- `./src/gtk-2.0/assets-dark.svg`
67
- `./src/gtk-3.0/gtk-common/assets.svg`
68
- `./src/gnome-shell/3.18/assets/checkbox.svg`
69
- `./src/gnome-shell/3.18/assets/more-results.svg`
70
- `./src/gnome-shell/3.18/assets/toggle-on.svg`
71
- `./src/gnome-shell/3.18/assets-dark/checkbox.svg`
72
- `./src/gnome-shell/3.18/assets-dark/more-results.svg`
73
- `./src/gnome-shell/3.18/assets-dark/toggle-on.svg`
74
75
2. Search `#FF4081` (default accent color) and replace with your favorite color.
76
77
- The recommended color palette is: https://material.io/guidelines/style/color.html#color-color-palette
78
79
3. For gtk2 and gtk3, delete all PNG assets before redrawing them.
80
81
```sh
82
rm ./src/gtk-2.0/assets/*.png
83
rm ./src/gtk-2.0/assets-dark/*.png
84
rm ./src/gtk-3.0/gtk-common/assets/*.png
85
```
86
87
4. Run `./render-assets.sh` or `./render-assets-dark.sh` to render the PNG assets.
88
89
> Note: Inkscape must be installed to run the scripts.
90
91
- for gtk2:
92
93
```sh
94
cd ./src/gtk-2.0
95
./render-assets.sh
96
./render-assets-dark.sh
97
```
98
99
- for gtk3:
100
101
```sh
102
cd ./src/gtk-3.0/gtk-common
103
./render-assets.sh
104
```
105
106
Useful Links
107
------------
108
109
Upstream theme sources:
110
- [GTK+ 4.0](https://github.com/GNOME/gtk/tree/master/gtk/theme/Adwaita)
111
- [3.22](https://github.com/GNOME/gtk/tree/gtk-3-22/gtk/theme/Adwaita)
112
- [3.20](https://github.com/GNOME/gtk/tree/gtk-3-20/gtk/theme/Adwaita)
113
- [3.18](https://github.com/GNOME/gtk/tree/gtk-3-18/gtk/theme/Adwaita)
114
- [GTK+ 2](https://github.com/GNOME/gnome-themes-standard/tree/master/themes/Adwaita/gtk-2.0)
115
- [GNOME Shell](https://github.com/GNOME/gnome-shell/tree/master/data/theme)
116
- [Sass sources](https://github.com/GNOME/gnome-shell-sass)
117
118
Tips:
119
- [Unity/Theming](https://wiki.ubuntu.com/Unity/Theming)
120
- [Material Design Guidelines](https://www.material.io/guidelines/)
121
- [Personal CSS Guidelines](https://github.com/nana-4/Flat-Plat/wiki/CSS-Guidelines)
122
- [The GTK+ Inspector](https://blog.gtk.org/2017/04/05/the-gtk-inspector/)
123