From 6ee15a4533e0decbf511d2663ff874ce660e288c Mon Sep 17 00:00:00 2001 From: Guanqun Lu Date: Thu, 26 Jul 2018 16:50:02 +0800 Subject: [PATCH] add a section in README to show how to build and test --- 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