From 67cd752e746bf2c2202949e15dbb85faf8e3c482 Mon Sep 17 00:00:00 2001
From: Raymond Liu <raymond.liu@intel.com>
Date: Fri, 6 Dec 2013 10:26:59 +0800
Subject: [PATCH] Add README for yarn modules

---
 yarn/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 yarn/README.md

diff --git a/yarn/README.md b/yarn/README.md
new file mode 100644
index 0000000000..3639f2c364
--- /dev/null
+++ b/yarn/README.md
@@ -0,0 +1,16 @@
+# YARN DIRECTORY LAYOUT
+
+Hadoop Yarn related code are organized 
+
+Hadoop Yarn related codes are organized in separate modules with layered dependency.
+
+ * common : Common codes that will be called into by other modules.
+
+ * 2.0 / 2.2 : Codes that involve specific version of Hadoop YARN API. Depends on common module.
+
+  2.0 actually represents  0.23 and 2.0
+  2.2 actually represents 2.2 and later, until the API is break again.
+
+ * Scheduler : Implementation of various YARN Scheduler and backend. Depends on 2.0 / 2.2 modules.
+ * Assembly : For maven build to assembly all other modules in Yarn into one single jar.
+
-- 
GitLab