summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2018-05-18 16:08:22 +0200
committerLinus Färnstrand <linus@mullvad.net>2018-05-22 10:19:29 +0200
commit7832f67cad4ad28ffc22d159489bfa85f9ad186e (patch)
tree4a41b3742443a155a0b34349f1b5ebc776a5b497
parentd6161c740dd5bab534dbbb69b4810de465407788 (diff)
downloadmullvadvpn-7832f67cad4ad28ffc22d159489bfa85f9ad186e.tar.xz
mullvadvpn-7832f67cad4ad28ffc22d159489bfa85f9ad186e.zip
Update README repository structure
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index 11b68d20c3..68b7aff019 100644
--- a/README.md
+++ b/README.md
@@ -11,10 +11,14 @@ Support for Linux, Windows, Android and iOS is in the making.
## Checking out the code
-This repository contains a submodule, so clone it recursively:
+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
+```
## Install toolchains and dependencies
@@ -181,11 +185,13 @@ the version of the app you are going to release. For example `2018.3-beta1` or `
- **main.js** - entry file for background process
- **routes.js** - routes configurator
- **transitions.js** - transition rules between views
-- **client-binaries/** - Git submodule containing binaries shipped with the client. Most notably
- the OpenVPN binaries.
- **init.js** - entry file for electron, points to compiled **main.js**
- **scripts/** - support scripts for development
- **test/** - Electron GUI tests
+- **dist-assets/** - Icons, binaries and other files used when creating the distributables
+ - **binaries/** - Git submodule containing binaries bundled with the app. For example the
+ statically linked OpenVPN binary. See the README in the submodule for details.
+ - **pkg-scripts/** - Scripts bundled with and executed by the macOS pkg installer
### Building, testing and misc
- **build.sh** - Sanity checks the working directory state and then builds release artifacts for