Update README.md

This commit is contained in:
Sam Hewitt 2016-04-14 23:41:36 -04:00
parent 99e452cf4b
commit 740f35a0f0
1 changed files with 18 additions and 16 deletions

View File

@ -1,26 +1,28 @@
Summary
Notes
-------
* Do not edit the CSS directly, edit the source SCSS files and process them with SASS (run
`./parse-sass.sh` when you have the required software installed, as described below)
* To be able to use the latest/adequate version of sass, install ruby, gem, sass & bundle.
* Do not edit the CSS files directly, edit the source SCSS files and process them with SASS (run
`sass --update --sourcemap=none .` in this directory when you have the required software installed)
* Do not edit the PNG or SVG assets directly, edit and render the sources in the `src` folder in the source root and render those.
## How to tweak the theme
## SASS Assets (SASSets)
Paper is a large and complex theme, to keep it maintainable it's written and processed in SASS.
Paper is a large and complex theme, to keep it maintainable and easily editable it's written and processed in SASS and organized in a modular fashion.
`_colors.scss`
- global color definitions. We keep the number of defined colors to a necessary minimum, most colors are derived form a handful of basics. It covers both the light variant and the dark variant.
_colors.scss - global color definitions. We keep the number of defined colors to a necessary minimum,
most colors are derived form 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.
_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.
_drawing.scss - drawing helper mixings/functions to allow easier definition of widget drawing under
specific context. This is why Paper isn't 15000 LOC.
`_common.scss`
- shared definitions for the theme
_common.scss - actual definitions of style for each widget. This is where you are likely to add/remove
your changes.
`widgets/_*.scss`
- styles for widgets are on individual sheets to make the theme more modular and easier to batch edit
apps/_*.scss - actual definitions of style for each widget. This is where you are likely to add/remove
your changes.
`_apps.scss` & `apps/_*.scss`
- style definitions for specific apps and environments. This is where colored headerbars are made