update READMEs

1 files changed, 31 insertions, 0 deletions

diff --git a/common/gtk-3.0/3.18/README.md b/common/gtk-3.0/3.18/README.md
new file mode 100644
index 0000000..af100ea
--- /dev/null
+++ b/common/gtk-3.0/3.18/README.md
@@ -0,0 +1,31 @@
+This theme uses libsass/gulp to process the sass/*.scss. Never edit any of the .css files manually.
+
+#### Editing the theme
+
+* Install `nvm` (https://github.com/creationix/nvm)
+
+* Install `gulp`
+
+        npm i -g gulp
+
+* Execute the following from the directory containing `gulpfile.js`
+
+        npm i
+
+* Edit the sass/*.scss files
+
+* Regenerate the .css files by executing from the directory containing `gulpfile.js`
+
+        gulp
+
+--
+
+#### Editing the images in the `assets` folder
+
+* Open the `assets.svg` file in inkscape. Each object in the .svg file corresponds to an image in the `assets` folder.
+
+* Find the object you want to edit and make your changes. Important: Don't change the obejct id.
+
+* Save `assets.svg` and delete the images corresponding to the edited .svg objects from the `assets` folder (or just delete everything in the `assets` folder).
+
+* Run `./render-assets.sh` from a terminal.