swish/commit

Explain how to update from upstream resources

authorJan Wielemaker
Tue Mar 31 10:01:40 2015 +0200
committerJan Wielemaker
Tue Mar 31 10:01:40 2015 +0200
commit0a242862fe2c85f3040a42a291fc69389e72c760
treebd230dbc2500138ac1b34da9a5b5815773db5a4d
parent49648e17d1979577e288d58b25e90fed5f6710d7
Diff style: patch stat
diff --git a/README.md b/README.md
index 79aa68d..ee5cb19 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,43 @@ interface to ClioPatria, providing:
 
 This package is just a first preview. We have many plans for making this
 more powerful and friendly.
+
+## Update the cpack to the latest SWISH
+
+Updating the SWISH cpack from the   upstream resources. Although you can
+probably get this done on any OS, I'd  strongly advice to use Linux. You
+may try on MacOS and if you're really motivated it might work on Windows
+using MinGW or Cygwin.
+
+  - Initialise the src git submodule if this was not done:
+
+	```
+	$ git submodule update --init
+	```
+
+  - Pull the latest upstream version of SWISH
+
+	```
+	$ cd src
+	$ git pull
+	$ bower install		# or `bower update` if already installed
+	```
+
+  - Make sure you have all the tools installed to do the JavaScript and
+    CSS building.  See README.md in src or online at
+    https://github.com/SWI-Prolog/swish
+
+  - Build the CSS and JS files. Might be wise to clean first. In `src`,
+    run:
+
+	```
+	$ make clean
+	$ make
+	```
+
+  - Now update the cpack from the directory holding this README.md using
+
+	```
+	$ make
+	```
+