diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 21 |
1 files changed, 5 insertions, 16 deletions
@@ -5,7 +5,7 @@ | |||
5 | 5 | ||
6 | # Franz 5 (beta) | 6 | # Franz 5 (beta) |
7 | [![Build status Windows](https://ci.appveyor.com/api/projects/status/9yman4ye19x4274o/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master) | 7 | [![Build status Windows](https://ci.appveyor.com/api/projects/status/9yman4ye19x4274o/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master) |
8 | [![Build Status Mac](https://travis-ci.org/meetfranz/franz.svg?branch=master)](https://travis-ci.org/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](http://meetfranz.com/payment.html) | 8 | [![Build Status Mac](https://travis-ci.org/meetfranz/franz.svg?branch=master)](https://travis-ci.org/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://meetfranz.com/payment.html) |
9 | 9 | ||
10 | Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more. | 10 | Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more. |
11 | 11 | ||
@@ -25,34 +25,23 @@ Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many mor | |||
25 | #### Install Linux OS dependencies | 25 | #### Install Linux OS dependencies |
26 | [Guide: Linux distribution specific dependencies](docs/linux.md) | 26 | [Guide: Linux distribution specific dependencies](docs/linux.md) |
27 | 27 | ||
28 | #### Install yarn | ||
29 | ##### MacOS | ||
30 | ```bash | ||
31 | $ brew install yarn | ||
32 | ``` | ||
33 | ##### Windows | ||
34 | [Download installer](https://yarnpkg.com/latest.msi) | ||
35 | |||
36 | ##### Linux | ||
37 | [Install Yarn on Linux](https://yarnpkg.com/lang/en/docs/install/) | ||
38 | |||
39 | #### Fix native modules to match current electron node version | 28 | #### Fix native modules to match current electron node version |
40 | ```bash | 29 | ```bash |
41 | $ yarn run rebuild | 30 | $ npm run rebuild |
42 | ``` | 31 | ``` |
43 | 32 | ||
44 | ### Run Franz Development App | 33 | ### Run Franz Development App |
45 | Run these two commands __simultaneously__ in different console tabs. | 34 | Run these two commands __simultaneously__ in different console tabs. |
46 | 35 | ||
47 | ```bash | 36 | ```bash |
48 | $ yarn run dev | 37 | $ npm run dev |
49 | $ yarn start | 38 | $ npm run start |
50 | ``` | 39 | ``` |
51 | Be aware that the development database will be reset regularly. | 40 | Be aware that the development database will be reset regularly. |
52 | 41 | ||
53 | ## Packaging | 42 | ## Packaging |
54 | ```bash | 43 | ```bash |
55 | $ yarn build | 44 | $ npm run build |
56 | ``` | 45 | ``` |
57 | 46 | ||
58 | ## How can I support the project? | 47 | ## How can I support the project? |