Add git submodule to the build docs

This confused me, and looking at the issues, it has confused other people as well. [1](https://github.com/shadowsocks/shadowsocks-libev/issues/2758)

I'm not sure if we can automate it though, e.g. in `autogen.sh`. Because some people might want to build with a modified version of the libraries.

Perhaps we could automatically fetch the submodules IF we see they are empty...

Anyway, for now, we can at least document this step.
This commit is contained in:
Paul "Joey" Clark
2021-08-27 08:11:33 +08:00
committed by Max Lv
parent b911755900
commit 3654658111
+8
View File
@@ -69,6 +69,14 @@ sudo snap install shadowsocks-libev --edge
* * *
### Initialise the build environment
This repository uses submodules, so you should pull them before you start, using:
```bash
git submodule update --init --recursive
```
### Pre-build configure guide
For a complete list of available configure-time option,