diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 16 |
1 files changed, 15 insertions, 1 deletions
@@ -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 |
32 | Run these two commands __simultaneously__ in different console tabs. | 46 | Run 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 |
52 | You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins). | 66 | You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins). |
53 | For questions feel free to ask in the [community Slack](http://slack.franz.im) | 67 | For 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 |