summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2018-06-26 16:46:39 +0200
committerLinus Färnstrand <linus@mullvad.net>2018-06-26 18:30:05 +0200
commit80ffc720db30fec274dd26d2ee114ba4a1f86cfb (patch)
tree8b98cfbf632e13ef27f632a9042df6af15207d28 /README.md
parentcd40c721336d6b86bd9b6e64963da182dc87096d (diff)
downloadmullvadvpn-80ffc720db30fec274dd26d2ee114ba4a1f86cfb.tar.xz
mullvadvpn-80ffc720db30fec274dd26d2ee114ba4a1f86cfb.zip
Update readme to use OS specific pack command
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 4 insertions, 10 deletions
diff --git a/README.md b/README.md
index 26a37bb891..03eadcb571 100644
--- a/README.md
+++ b/README.md
@@ -118,17 +118,11 @@ The GUI will need to resolve the path to binaries. In development mode this defa
1. Install all JavaScript dependencies (unless you already have) and package the application with:
```bash
yarn install
- yarn run pack
+ yarn run pack:<OS> # <OS> can be linux, mac or win
```
- This will create installation packages for windows, linux and MacOS. Note that you have to have
+ This will create installation packages for windows, linux or macOS. Note that you have to have
run `yarn install` at least once before this step to download the javascript dependencies.
- If you only want to build for a specific OS you run
- ```bash
- yarn run pack:OS
- ```
- as in `yarn run pack:linux`.
-
The artifact (.pkg, .deb, .msi) version is the `version` property of `package.json`.
@@ -185,8 +179,8 @@ this procedure, the `integration-tests.sh` script can be used to run all integra
- `$ yarn run develop` - develop app with live-reload enabled
- `$ yarn run flow` - type-check the code
- `$ yarn run lint` - lint code
-- `$ yarn run pack` - prepare app for distribution for macOS, Windows, Linux. Use `pack:mac`,
- `pack:win` or `pack:linux` to generate package for single target.
+- `$ yarn run pack:<OS>` - prepare app for distribution for your platform. Where `<OS>` can be
+ `linux`, `mac` or `win`
- `$ yarn run test` - run tests
## Repository structure