Explain make kss environment variable in README
authorMatthew Flaschen <mflaschen@wikimedia.org>
Fri, 11 Apr 2014 02:39:28 +0000 (22:39 -0400)
committerMatthew Flaschen <mflaschen@wikimedia.org>
Tue, 22 Apr 2014 03:12:24 +0000 (23:12 -0400)
Change-Id: I9e83187050ed360c57a1c3d4aeba913d69211349

docs/kss/README.txt

index d91bf2a..f9473b8 100644 (file)
@@ -2,3 +2,17 @@ The Makefile, package.json, scripts, styleguide-template, and
 mediawiki.ui/styleguide.md files and directories in here support the automatic
 generation of CSS documentation from the source LESS files using kss for
 node.js, https://github.com/kneath/kss
+
+To build and open in your web browser, run:
+
+MEDIAWIKI_LOAD_URL=mediawiki_hostname/w/load.php make kssopen
+
+For example,
+
+MEDIAWIKI_LOAD_URL=1.2.3.4/w/load.php make kssopen
+
+If MediaWiki is running on localhost, you can omit MEDIAWIKI_LOAD_URL.
+
+To rebuild without opening the web browser, run:
+
+MEDIAWIKI_LOAD_URL=mediawiki_hostname/w/load.php make