summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Lively <7121787+tlively@users.noreply.github.com>2022-02-01 14:27:20 -0800
committerGitHub <noreply@github.com>2022-02-01 14:27:20 -0800
commit348131b0a383d2946f18923f7acfd963089f4f5d (patch)
tree3999c7da8e1aeb0c35a39be8df08c3a08f67e357
parentc09ce3db9b938cf0cf1f0031f6bfd35aa1d81b3b (diff)
downloadbinaryen-348131b0a383d2946f18923f7acfd963089f4f5d.tar.gz
binaryen-348131b0a383d2946f18923f7acfd963089f4f5d.tar.bz2
binaryen-348131b0a383d2946f18923f7acfd963089f4f5d.zip
Document submodule initialization in README (#4489)
Add the missing initialization instructions to the `Building` section. Fixes #4488.
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index a35518c27..d42f9eeb2 100644
--- a/README.md
+++ b/README.md
@@ -305,6 +305,15 @@ etc.
## Building
+Binaryen uses git submodules (at time of writing just for gtest), so before you build you will have to initialize the submodules:
+
+```
+git submodule init
+git submodule update
+```
+
+After that you can build with CMake:
+
```
cmake . && make
```