Skip to content

Commit

Permalink
Add git submodule to the build docs
Browse files Browse the repository at this point in the history
This confused me, and looking at the issues, it has confused other people as well. [1](shadowsocks#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.
  • Loading branch information
joeytwiddle authored and Max Lv committed Aug 27, 2021
1 parent b911755 commit 3654658
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 3654658

Please sign in to comment.