[Kimchi-devel] [PATCH 3/3] Update README.md with submodules information.

pvital at linux.vnet.ibm.com pvital at linux.vnet.ibm.com
Wed Oct 7 18:28:51 UTC 2015


From: Paulo Vital <pvital at linux.vnet.ibm.com>

Signed-off-by: Paulo Vital <pvital at linux.vnet.ibm.com>
---
 docs/README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/docs/README.md b/docs/README.md
index f0b8697..ff521e0 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -148,6 +148,31 @@ Allow httpd_t context for Wok web server:
         $ sudo semanage permissive -a httpd_t
 
 
+Wok Plugins
+-----------
+
+Wok provides a Sample plugin to education purposes that can be used to create
+new plugins. Also, by default, Wok is linked to Kimchi (Virtualization
+ Management) and Ginger (System Administration) repositories as git submodules.
+
+To clone Kimchi source code, execute:
+
+    $ cd src/wok/plugins/kimchi
+    $ git submodule init
+    $ git submodule update
+
+To clone Ginger source code, execute:
+
+    $ cd src/wok/plugins/ginger
+    $ git submodule init
+    $ git submodule update
+
+To automatically clone Kimchi and Ginger source code, use the following git
+command when cloning Wok project:
+
+    $ git clone --recursive https://github.com/kimchi-project/wok.git
+
+
 Participating
 -------------
 
-- 
2.4.3




More information about the Kimchi-devel mailing list