summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2018-06-28 10:35:52 +0200
committerLinus Färnstrand <linus@mullvad.net>2018-06-28 14:51:25 +0200
commite64ac6d0a1306cbbfa9a984227d6187c61bcc69a (patch)
tree60afaef4bd0fb68ca83366653c8adbfe1634c589
parenta8b224c414284ab2d737e0715f890e162394ff77 (diff)
downloadmullvadvpn-e64ac6d0a1306cbbfa9a984227d6187c61bcc69a.tar.xz
mullvadvpn-e64ac6d0a1306cbbfa9a984227d6187c61bcc69a.zip
Improve readme with git clone instructions and windows prerequisites
-rw-r--r--README.md36
1 files changed, 23 insertions, 13 deletions
diff --git a/README.md b/README.md
index 03eadcb571..1bd128bdcc 100644
--- a/README.md
+++ b/README.md
@@ -11,31 +11,41 @@ Support for Linux, Windows, Android and iOS is in the making.
## Checking out the code
-This repository contains submodules, so clone it recursively:
-```
-git clone --recursive https://github.com/mullvad/mullvadvpn-app.git
-```
-Or if you already cloned it non-recursively:
-```
-git submodule update --init --recursive
+This repository contains submodules needed for building the app. However, some of those submodules
+also have further submodules that are quite large and not needed to build the app. So unless
+you want the source code for OpenSSL, OpenVPN and a few other projects you should avoid a recursive
+clone of the repository. Instead clone the repository normally and then get one level of submodules:
+```bash
+git clone https://github.com/mullvad/mullvadvpn-app.git
+cd mullvadvpn-app
+git submodule update --init
```
## Install toolchains and dependencies
-Follow the instructions for your platform, and then the [All platforms](#all-platforms) instructions.
+Follow the instructions for your platform, and then the [All platforms](#all-platforms)
+instructions.
These instructions are probably not complete. If you find something more that needs installing
on your platform please submit an issue or a pull request.
### Windows
-- The host has to have Microsoft's _Build Tools for Visual Studio 2017_ (a
-regular installation of Visual Studio 2017 Community edition works as well).
+The host has to have the following installed:
+
+- Microsoft's _Build Tools for Visual Studio 2017_ (a regular installation of Visual Studio 2017
+ Community edition works as well).
+
+- Windows SDK *10.0.16299.0* (This exact version required)
-- The host has to have `msbuild.exe` available in `%PATH%`.
+- `msbuild.exe` available in `%PATH%`. If you installed Visual Studio Community edition, the
+ binary can be found under:
+ ```
+ C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\<VERSION>\Bin\amd64
+ ```
-- The host has to have `bash` installed as well as a few base unix utilities, including `sed` and
- `tail`. The environment coming with [Git for Windows] works fine.
+- `bash` installed as well as a few base unix utilities, including `sed` and `tail`.
+ The environment coming with [Git for Windows] works fine.
[Git for Windows]: https://git-scm.com/download/win