From 2ee35c9d3a6107beb0cc7377453cc5c2ed5da908 Mon Sep 17 00:00:00 2001 From: Till Schneidereit Date: Mon, 9 Mar 2020 12:52:13 +0100 Subject: [PATCH] Add instructions to initialize git submodules to build docs --- docs/contributing-building.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/contributing-building.md b/docs/contributing-building.md index 676a5e355f..688780aaa3 100644 --- a/docs/contributing-building.md +++ b/docs/contributing-building.md @@ -7,6 +7,16 @@ This section describes everything required to build and run Wasmtime. Before we can actually build Wasmtime, we'll need to make sure these things are installed first. +### Git Submodules + +The Wasmtime repository contains a number of git submodules. To build Wasmtime +and most other crates in the repository, you have to ensure that those are +initialized with this command: + +```shell +git submodule init && git submodule update +``` + ### The Rust Toolchain [Install the Rust toolchain here.](https://www.rust-lang.org/tools/install) This