aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Stefan Malzner <stefan@adlk.io>2018-11-15 12:25:36 +0100
committerLibravatar Stefan Malzner <stefan@adlk.io>2018-11-15 12:25:36 +0100
commite109e62eef136feb17d5a8663fbd2b2355a6bf67 (patch)
tree7d40b506206f5e333b10f025942c1b7f45fd68cd /README.md
parentfix(General): Convert many links from http to https (#967) @Stanzilla (diff)
parentAdd misty config (diff)
downloadferdium-app-e109e62eef136feb17d5a8663fbd2b2355a6bf67.tar.gz
ferdium-app-e109e62eef136feb17d5a8663fbd2b2355a6bf67.tar.zst
ferdium-app-e109e62eef136feb17d5a8663fbd2b2355a6bf67.zip
Merge branch 'chore/update-dependencies' into develop
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 4 insertions, 22 deletions
diff --git a/README.md b/README.md
index ab30e1d31..ff371b737 100644
--- a/README.md
+++ b/README.md
@@ -20,34 +20,23 @@ Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many mor
20#### Install Linux OS dependencies 20#### Install Linux OS dependencies
21[Guide: Linux distribution specific dependencies](docs/linux.md) 21[Guide: Linux distribution specific dependencies](docs/linux.md)
22 22
23#### Install yarn
24##### MacOS
25```bash
26$ brew install yarn
27```
28##### Windows
29[Download installer](https://yarnpkg.com/latest.msi)
30
31##### Linux
32[Install Yarn on Linux](https://yarnpkg.com/lang/en/docs/install/)
33
34#### Fix native modules to match current electron node version 23#### Fix native modules to match current electron node version
35```bash 24```bash
36$ yarn run rebuild 25$ npm run rebuild
37``` 26```
38 27
39### Run Franz Development App 28### Run Franz Development App
40Run these two commands __simultaneously__ in different console tabs. 29Run these two commands __simultaneously__ in different console tabs.
41 30
42```bash 31```bash
43$ yarn run dev 32$ npm run dev
44$ yarn start 33$ npm run start
45``` 34```
46Be aware that the development database will be reset regularly. 35Be aware that the development database will be reset regularly.
47 36
48## Packaging 37## Packaging
49```bash 38```bash
50$ yarn build 39$ npm run build
51``` 40```
52 41
53## How can I support the project? 42## How can I support the project?
@@ -60,12 +49,5 @@ Join the Franz community on [Slack](http://slack.franz.im) and get in touch with
60You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins). 49You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins).
61For questions feel free to ask in the [community Slack](http://slack.franz.im) 50For questions feel free to ask in the [community Slack](http://slack.franz.im)
62 51
63## Next steps
64- [ ] Create acceptance tests
65- [ ] Create Linux build
66- [ ] 5.0 stable release
67- [ ] Developer Documentation
68- [ ] Add translations
69
70## License 52## License
71Franz 5 is open-source licensed under the Apache-2.0 License. 53Franz 5 is open-source licensed under the Apache-2.0 License.