aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Stefan Malzner <stefan@adlk.io>2018-12-02 15:08:07 +0100
committerLibravatar Stefan Malzner <stefan@adlk.io>2018-12-02 15:08:07 +0100
commita5aa5e1380a0847eb33be3315d164fb9e0e23255 (patch)
treea1ea4b0f635cabb54d9cf028809d2f079727b9a1 /README.md
parentAdd instruction to install Franz with homebrew (#1134) (diff)
parentMerge branch 'develop' into release/5.0.0-beta.19 (diff)
downloadferdium-app-a5aa5e1380a0847eb33be3315d164fb9e0e23255.tar.gz
ferdium-app-a5aa5e1380a0847eb33be3315d164fb9e0e23255.tar.zst
ferdium-app-a5aa5e1380a0847eb33be3315d164fb9e0e23255.zip
Merge branch 'release/5.0.0-beta.19'
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 5 insertions, 16 deletions
diff --git a/README.md b/README.md
index 012a30fc9..4d024c3be 100644
--- a/README.md
+++ b/README.md
@@ -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
10Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more. 10Messaging 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
45Run these two commands __simultaneously__ in different console tabs. 34Run 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```
51Be aware that the development database will be reset regularly. 40Be 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?