[09/17] incubator-ponymail git commit: add a readme for coffe-and-cake

[hu...@apache.org]

add a readme for coffe-and-cake


Project: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/commit/47a22fc1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/tree/47a22fc1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/diff/47a22fc1

Branch: refs/heads/coffee-and-cake
Commit: 47a22fc1f46fe4fa04041ee699bc12ed8fd24cce
Parents: 7b308de
Author: Daniel Gruno <hu...@apache.org>
Authored: Thu Sep 1 17:43:51 2016 +0200
Committer: Daniel Gruno <hu...@apache.org>
Committed: Thu Sep 1 17:43:51 2016 +0200

----------------------------------------------------------------------
 site/js/coffee/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-ponymail/blob/47a22fc1/site/js/coffee/README.md
----------------------------------------------------------------------
diff --git a/site/js/coffee/README.md b/site/js/coffee/README.md
new file mode 100644
index 0000000..62db6b9
--- /dev/null
+++ b/site/js/coffee/README.md
@@ -0,0 +1,19 @@
+# Building Pony Mail Coffee-and-Cake for Production #
+Most of Pony Mail is ready-for-deployment files that just need to be checked out
+in order to work. Some areas, such as the CofeeScript needs to be compiled and combined
+by a script, as they have been split into several smaller files to make it easier to 
+find and work on various elements of the rendering process.
+
+### Building the JavaScript amalgamation ###
+All edits should be done to the `site/js/coffee/*.coffee` files.
+Once done, you should run combine.sh in the `site/js/coffee` directory 
+to generate ponymail-coffee.js from the scripts in the dev dir:
+
+    $cd site/js/coffee
+    $bash combine.sh
+    (coffeescript output goes here...)
+    Done!
+    $
+
+You may choose to commit the initial Coffee changes first before 
+committing the new amalgamated JS, but that's up to you.