aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Gustavo Sampaio <gbritosampaio@gmail.com>2017-10-16 23:32:28 -0300
committerLibravatar Gustavo Sampaio <gbritosampaio@gmail.com>2017-10-16 23:52:43 -0300
commit53878cab982ab9071967731bf914de8038bd7ca6 (patch)
tree8178b82114df092973766bb893cdbd0f34538d60 /README.md
parentfix wrong slack link (diff)
downloadferdium-app-53878cab982ab9071967731bf914de8038bd7ca6.tar.gz
ferdium-app-53878cab982ab9071967731bf914de8038bd7ca6.tar.zst
ferdium-app-53878cab982ab9071967731bf914de8038bd7ca6.zip
Add Linux (Debian/Ubuntu) build instructions
This helps #3 [ci skip]
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index ef5dcfacb..fec639aff 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,13 @@ Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many mor
13## Development 13## Development
14 14
15### Preparations 15### Preparations
16
17#### Install OS Dependencies
18##### Linux (Debian/Ubuntu)
19```bash
20$ apt install libx11-dev libxext-dev libxss-dev libxkbfile-dev
21```
22
16#### Install yarn 23#### Install yarn
17##### MacOS 24##### MacOS
18```bash 25```bash
@@ -21,12 +28,19 @@ $ brew install yarn
21##### Windows 28##### Windows
22[Download installer](https://yarnpkg.com/latest.msi) 29[Download installer](https://yarnpkg.com/latest.msi)
23 30
31##### Linux
32[Install Yarn on Linux](https://yarnpkg.com/lang/en/docs/install/)
33
24#### Install Gulp 4 34#### Install Gulp 4
25```bash 35```bash
26$ yarn add global gulp-cli@1.2.2 36$ yarn add global gulp-cli@1.2.2
27$ yarn add global gulpjs/gulp#4.0 37$ yarn add global gulpjs/gulp#4.0
28``` 38```
29 39
40#### Fix native modules to match current electron node version
41```bash
42$ yarn run rebuild
43```
30 44
31### Run Franz Development App 45### Run Franz Development App
32Run these two commands __simultaneously__ in different console tabs. 46Run these two commands __simultaneously__ in different console tabs.
@@ -50,7 +64,7 @@ Join the Franz community on [Slack](http://slack.franz.im) and get in touch with
50 64
51## Create your own plugins/recipes 65## Create your own plugins/recipes
52You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins). 66You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins).
53For questions feel free to ask in the [community Slack](http://slack.franz.im) 67For questions feel free to ask in the [community Slack](http://slack.franz.im)
54 68
55## Next steps 69## Next steps
56- [ ] Create acceptance tests 70- [ ] Create acceptance tests