From 8ca6b4b8607262f7380e0e1c1271971daf497312 Mon Sep 17 00:00:00 2001
From: Guanqun Lu <guanqun.lu@gmail.com>
Date: Wed, 1 Aug 2018 17:21:50 +0800
Subject: [PATCH] Add a section in README to show how to build and test (#117)

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 57e16dd..8d2b2f5 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,17 @@ license and the Apache License (Version 2.0), at your choice.
 
 See LICENSE-APACHE, and LICENSE-MIT for details.
 
+# Build & Test
+
+As `wasmi` contains a git submodule, you need to use `--recursive` for cloning or to checkout the submodule explicitly, otherwise the testing would fail.
+
+```
+git clone https://github.com/paritytech/wasmi.git --recursive
+cd wasmi
+cargo build
+cargo test
+```
+
 ## Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted