update READMEs

15 files changed, 189 insertions, 133 deletions

diff --git a/common/cinnamon/README b/common/cinnamon/README
deleted file mode 100644
index f040030..0000000
--- a/common/cinnamon/README
+++ /dev/null
@@ -1,19 +0,0 @@
-This theme uses libsass/gulp to process the sass/*.scss. Never edit any of the .css files manually.
-
-How to edit this theme:
-
-1. Install `nodejs` and `npm`
-
-2. Install `gulp`
-
-    sudo npm install --global gulp
-
-3. Execute the following from the directory containing `gulpfile.js`
-
-    npm install
-
-4. Edit the sass/*.scss files
-
-5. Regenerate the .css files by executing from the directory containing `gulpfile.js`
-
-    gulp
diff --git a/common/cinnamon/README.md b/common/cinnamon/README.md
new file mode 100644
index 0000000..b717ab9
--- /dev/null
+++ b/common/cinnamon/README.md
@@ -0,0 +1,20 @@
+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
+
diff --git a/common/gnome-shell/3.14/README b/common/gnome-shell/3.14/README
deleted file mode 100644
index f040030..0000000
--- a/common/gnome-shell/3.14/README
+++ /dev/null
@@ -1,19 +0,0 @@
-This theme uses libsass/gulp to process the sass/*.scss. Never edit any of the .css files manually.
-
-How to edit this theme:
-
-1. Install `nodejs` and `npm`
-
-2. Install `gulp`
-
-    sudo npm install --global gulp
-
-3. Execute the following from the directory containing `gulpfile.js`
-
-    npm install
-
-4. Edit the sass/*.scss files
-
-5. Regenerate the .css files by executing from the directory containing `gulpfile.js`
-
-    gulp
diff --git a/common/gnome-shell/3.14/README.md b/common/gnome-shell/3.14/README.md
new file mode 100644
index 0000000..b717ab9
--- /dev/null
+++ b/common/gnome-shell/3.14/README.md
@@ -0,0 +1,20 @@
+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
+
diff --git a/common/gnome-shell/3.16/README b/common/gnome-shell/3.16/README
deleted file mode 100644
index f040030..0000000
--- a/common/gnome-shell/3.16/README
+++ /dev/null
@@ -1,19 +0,0 @@
-This theme uses libsass/gulp to process the sass/*.scss. Never edit any of the .css files manually.
-
-How to edit this theme:
-
-1. Install `nodejs` and `npm`
-
-2. Install `gulp`
-
-    sudo npm install --global gulp
-
-3. Execute the following from the directory containing `gulpfile.js`
-
-    npm install
-
-4. Edit the sass/*.scss files
-
-5. Regenerate the .css files by executing from the directory containing `gulpfile.js`
-
-    gulp
diff --git a/common/gnome-shell/3.16/README.md b/common/gnome-shell/3.16/README.md
new file mode 100644
index 0000000..b717ab9
--- /dev/null
+++ b/common/gnome-shell/3.16/README.md
@@ -0,0 +1,20 @@
+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
+
diff --git a/common/gnome-shell/3.18/README b/common/gnome-shell/3.18/README
deleted file mode 100644
index f040030..0000000
--- a/common/gnome-shell/3.18/README
+++ /dev/null
@@ -1,19 +0,0 @@
-This theme uses libsass/gulp to process the sass/*.scss. Never edit any of the .css files manually.
-
-How to edit this theme:
-
-1. Install `nodejs` and `npm`
-
-2. Install `gulp`
-
-    sudo npm install --global gulp
-
-3. Execute the following from the directory containing `gulpfile.js`
-
-    npm install
-
-4. Edit the sass/*.scss files
-
-5. Regenerate the .css files by executing from the directory containing `gulpfile.js`
-
-    gulp
diff --git a/common/gnome-shell/3.18/README.md b/common/gnome-shell/3.18/README.md
new file mode 100644
index 0000000..b717ab9
--- /dev/null
+++ b/common/gnome-shell/3.18/README.md
@@ -0,0 +1,20 @@
+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
+
diff --git a/common/gtk-2.0/README.md b/common/gtk-2.0/README.md
new file mode 100644
index 0000000..48c45f1
--- /dev/null
+++ b/common/gtk-2.0/README.md
@@ -0,0 +1,16 @@
+#### Editing the theme
+
+* The Colors and includes are defined in `gtkrc`, `gtkrc-dark` and `gtkrc-darker` for each theme variant.
+* `main.rc` contains the major part of the theme
+* `panel.rc` contains the panel styling for XFCE and Mate
+* `apps.rc` contains some application specific rules
+
+Because this theme is heavily based on the pixmap engine, a lot of the styling comes from the images in the `assets` and `assets-dark` folders. Don't edit these images directly. Instead do the following
+
+* Open the `assets.svg` or `assets-dark.svg` file in inkscape. Each object in the .svg file corresponds to an image in the `assets` and `assets-dark` folder.
+
+* Find the object you want to edit and make your changes. Important: Don't change the obejct id.
+
+* Save `assets.svg` or `assets-dark.svg` and delete the images corresponding to the edited .svg objects from the `assets` or `assets-dark` folder (or just delete everything in the `assets` or `assets-dark` folder).
+
+* Run `./render-assets.sh` or `./render-dark-assets.sh` from a terminal.
diff --git a/common/gtk-3.0/3.14/README b/common/gtk-3.0/3.14/README
deleted file mode 100644
index f040030..0000000
--- a/common/gtk-3.0/3.14/README
+++ /dev/null
@@ -1,19 +0,0 @@
-This theme uses libsass/gulp to process the sass/*.scss. Never edit any of the .css files manually.
-
-How to edit this theme:
-
-1. Install `nodejs` and `npm`
-
-2. Install `gulp`
-
-    sudo npm install --global gulp
-
-3. Execute the following from the directory containing `gulpfile.js`
-
-    npm install
-
-4. Edit the sass/*.scss files
-
-5. Regenerate the .css files by executing from the directory containing `gulpfile.js`
-
-    gulp
diff --git a/common/gtk-3.0/3.14/README.md b/common/gtk-3.0/3.14/README.md
new file mode 100644
index 0000000..af100ea
--- /dev/null
+++ b/common/gtk-3.0/3.14/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.
diff --git a/common/gtk-3.0/3.16/README b/common/gtk-3.0/3.16/README
deleted file mode 100644
index f040030..0000000
--- a/common/gtk-3.0/3.16/README
+++ /dev/null
@@ -1,19 +0,0 @@
-This theme uses libsass/gulp to process the sass/*.scss. Never edit any of the .css files manually.
-
-How to edit this theme:
-
-1. Install `nodejs` and `npm`
-
-2. Install `gulp`
-
-    sudo npm install --global gulp
-
-3. Execute the following from the directory containing `gulpfile.js`
-
-    npm install
-
-4. Edit the sass/*.scss files
-
-5. Regenerate the .css files by executing from the directory containing `gulpfile.js`
-
-    gulp
diff --git a/common/gtk-3.0/3.16/README.md b/common/gtk-3.0/3.16/README.md
new file mode 100644
index 0000000..af100ea
--- /dev/null
+++ b/common/gtk-3.0/3.16/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.
diff --git a/common/gtk-3.0/3.18/README b/common/gtk-3.0/3.18/README
deleted file mode 100644
index f040030..0000000
--- a/common/gtk-3.0/3.18/README
+++ /dev/null
@@ -1,19 +0,0 @@
-This theme uses libsass/gulp to process the sass/*.scss. Never edit any of the .css files manually.
-
-How to edit this theme:
-
-1. Install `nodejs` and `npm`
-
-2. Install `gulp`
-
-    sudo npm install --global gulp
-
-3. Execute the following from the directory containing `gulpfile.js`
-
-    npm install
-
-4. Edit the sass/*.scss files
-
-5. Regenerate the .css files by executing from the directory containing `gulpfile.js`
-
-    gulp
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.