summaryrefslogtreecommitdiff
path: root/swatchmaker/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'swatchmaker/README.md')
-rw-r--r--swatchmaker/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/swatchmaker/README.md b/swatchmaker/README.md
new file mode 100644
index 00000000..b9c8595d
--- /dev/null
+++ b/swatchmaker/README.md
@@ -0,0 +1,28 @@
+Create your own swatch
+======================
+
+1. Download Bootstrap
+------
+Download and unpack [swatchmaker.zip](https://github.com/thomaspark/bootswatch/blob/master/swatchmaker/swatchmaker.zip?raw=true). In terminal, navigate to `swatchmaker/` and run the command `make bootstrap` to update to the latest version of Bootstrap.
+
+
+2. Install LESS
+------
+If you haven't already, install LESS to your machine via NPM. More information on that here: http://lesscss.org/#-server-side-usage
+
+
+3. Customize Bootstrap
+------
+Make your customizations to the two files found in the `swatch` directory, `variables.less` and `bootswatch.less`.
+
+
+4. Build Customized Bootstrap
+------
+In the `swatchmaker` directory, run `make bootswatch`. The compiled CSS files will be created in the `swatch` directory.
+
+You can run the watcher to automatically build Bootstrap whenever changes are saved with `ruby watcher.rb`. Requires `gem install directory_watcher`.
+
+
+5. Reset Bootstrap
+------
+If you want to reset `variables.less` and `bootswatch.less` to defaults, run `make default`. \ No newline at end of file