Merge branch 'JAL-957_jbake' into Release_2_8_Branch

[jalview.git] / examples-jbake / README

diff --git a/examples-jbake/README b/examples-jbake/README
new file mode 100644 (file)
index 0000000..f9fcde1
--- /dev/null
+++ b/examples-jbake/README
@@ -0,0 +1,25 @@
+#examples-jbake
+#==============
+
+#This directory contains a jbake project that regenerates the JalviewLite example pages
+#shown at http://www.jalview.org/examples/applets.html
+
+#Instructions for building the examples directory from the jbake project:
+
+#Download jbake and add it to your path:
+#http://hash.to/2R
+#(unzip the download and add the extracted directory to your path)
+
+cd examples-jbake
+
+# this generates the example pages in the 'output' directory
+jbake
+
+# jbake -s will test the output. Copy build artefacts (jalviewLite/JmolApplet jars) into the assets directory to create a real test
+
+# remove the pages jbake autogenerates
+rm output/archive.html output/index.html output/feed.xml
+
+# and copy all the rest to examples
+cp output/*.html ../examples/
+cp -R output/css output/images ../examples/