paper-gtk-theme/README.md

51 lines
1.6 KiB
Markdown
Raw Normal View History

2014-12-15 18:09:13 +01:00
Paper Theme
===========
2014-12-13 18:48:16 +01:00
2014-12-18 06:15:22 +01:00
[Paper](http://snwh.org/paper/) is a modern desktop theme suite. Its design is mostly flat with a minimal use of shadows for depth.
2014-12-13 18:48:16 +01:00
###Preamble
2015-03-13 19:18:38 +01:00
Paper has been developed primarily with modern GTK3 (GNOME-based) desktop environments in mind, legacy-toolkit and GTK2 environments will not provide an ideal experience, as much of the visual design relies on modern GTK3+ widgets.
2014-12-18 06:01:33 +01:00
Paper is distributed under the terms the GNU General Public License (GNU GPL v.3).
2014-12-18 06:03:36 +01:00
###Installation & Usage
2015-03-13 19:18:38 +01:00
2014-12-18 06:03:36 +01:00
If you download the provided archive, extract it and run the included install script.
bash install.sh
2014-12-18 06:01:33 +01:00
###Bugs & Issues
2014-12-13 18:48:16 +01:00
If you find any bugs or issues with Paper or if you have a question, you can visit Paper's primary issue tracker on [GitHub](https://github.com/snwh/paper-gtk-theme/issues).
###Getting the Source
The source for Paper GTK3 Theme can be found [here](https://github.com/snwh/paper-gtk-theme).
Alternatively, you can clone the latest version its git repository:
git clone https://github.com/snwh/paper-gtk-theme.git
###Using the Source
2015-03-13 19:20:32 +01:00
There are scripts to simplify the rendering process;to run them (and edit theme assets) you will need:
2014-12-13 18:48:16 +01:00
* inkscape
* python3
To render new assets from their source SVG files, run the following:
./render-gtk3-assets.py
./render-gtk3-assets-hidpi.py
2014-12-15 18:09:13 +01:00
./render-gnome-shell-assets.py
2015-03-11 06:31:45 +01:00
./render-wm-assets.py
2014-12-13 18:48:16 +01:00
2015-03-13 19:18:38 +01:00
If scripts are throwing errors, they may not be executable, try:
2014-12-13 18:48:16 +01:00
chmod +x *
2015-03-13 19:18:38 +01:00
Each script will look in the asset source directories (../src/*) and render the respective assets (provided there are changes) to the appropriate locations.
2014-12-13 18:48:16 +01:00
-----------