summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2018-06-19 10:33:22 +0200
committerLinus Färnstrand <linus@mullvad.net>2018-06-19 15:14:49 +0200
commit71fd333c0a1bbbf6a2cd5a803bc0ed2dc2b92772 (patch)
treefd82928bed123db4d78ec09ae53f046b1d2a3598 /README.md
parent8c4f4a05fbb776e747e9ff10ea626cf85e188571 (diff)
downloadmullvadvpn-71fd333c0a1bbbf6a2cd5a803bc0ed2dc2b92772.tar.xz
mullvadvpn-71fd333c0a1bbbf6a2cd5a803bc0ed2dc2b92772.zip
Update prerequisites section of README
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 32 insertions, 21 deletions
diff --git a/README.md b/README.md
index b196eca8c9..becd35065f 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,32 @@ git submodule update --init --recursive
## Install toolchains and dependencies
+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 `msbuild.exe` available in `%PATH%`.
+
+- The host has to have `bash` installed. The one coming with [Git for Windows] works.
+
+[Git for Windows]: https://git-scm.com/download/win
+
+### Linux
+
+For Debian based distributions, you need to install the following. For other distributions you need
+the equivalent packages:
+```bash
+sudo apt install gcc libssl-dev libappindactor1
+```
+
+### All platforms
+
1. Get the latest stable Rust toolchain. This is easy with rustup, follow the instructions on
[rustup.rs](https://rustup.rs/).
@@ -31,13 +57,14 @@ homebrew:
brew install node yarn
```
-1. Install build dependencies if you are on Linux
+## Building and running mullvad-daemon
+
+1. If you are on Windows, then you have to build the C++ libraries before compiling the daemon.
+ Run `build_winfw.sh` to build a C++ library that sets firewall rules on Windows.
```bash
- sudo apt install icnsutils graphicsmagick
+ bash build_winfw.sh
```
-## Building and running mullvad-daemon
-
1. Build the daemon without optimizations (debug mode) with:
```
cargo build
@@ -50,27 +77,11 @@ homebrew:
1. Run the daemon debug binary with verbose logging to the terminal with:
```
- sudo ./target/debug/mullvad-daemon -vv --resource-dir dist-assets/
+ sudo MULLVAD_RESOURCE_DIR="./dist-assets" ./target/debug/mullvad-daemon -vv
```
It must run as root since it it modifies the firewall and sets up virtual network interfaces
etc.
-### Prerequisites for Windows
-There are some extra steps to build the daemon on 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 specific build tool version that is required is `v141`.
-
-- The host has to have `msbuild.exe` available in `%PATH%`.
-
-- The host has to have `bash` installed.
-
-- Before compiling the daemon, one must run `build_winfw.sh` to build a C++
- library that sets firewall rules on Windows.
- ```bash
- bash build_winfw.sh
- ```
-
## Building and running the Electron GUI app
1. Install all the JavaScript dependencies by running: