diff options
author | Stefan Malzner <stefan@adlk.io> | 2017-10-13 12:29:40 +0200 |
---|---|---|
committer | Stefan Malzner <stefan@adlk.io> | 2017-10-13 12:29:40 +0200 |
commit | 58cda9cc7fb79ca9df6746de7f9662bc08dc156a (patch) | |
tree | 1211600c2a5d3b5f81c435c6896618111a611720 /README.md | |
download | ferdium-app-58cda9cc7fb79ca9df6746de7f9662bc08dc156a.tar.gz ferdium-app-58cda9cc7fb79ca9df6746de7f9662bc08dc156a.tar.zst ferdium-app-58cda9cc7fb79ca9df6746de7f9662bc08dc156a.zip |
initial commit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..fbb8b8760 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,54 @@ | |||
1 | **This repository is only for Franz 5 and later, previous versions are no longer maintained.** | ||
2 | --- | ||
3 | |||
4 | <img src="./build-helpers/images/icon.png" alt="" width="150"/> | ||
5 | |||
6 | # Franz 5 (beta) [![Build status Windows](https://ci.appveyor.com/api/projects/status/22e01sssgdt90d34/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master) [![Build Status Mac](https://travis-ci.com/meetfranz/franz.svg?token=9zxYPVb6RdKVnmTFMJLX&branch=master)](https://travis-ci.com/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](http://meetfranz.com/payment.html) | ||
7 | |||
8 | Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more. | ||
9 | |||
10 | |||
11 | ## Development | ||
12 | |||
13 | ### Preparations | ||
14 | #### Install yarn | ||
15 | ##### MacOS | ||
16 | ```bash | ||
17 | $ brew install yarn | ||
18 | ``` | ||
19 | ##### Windows | ||
20 | [Download installer](https://yarnpkg.com/latest.msi) | ||
21 | |||
22 | #### Install Gulp 4 | ||
23 | ```bash | ||
24 | $ yarn add global gulp-cli@1.2.2 | ||
25 | $ yarn add global gulpjs/gulp#4.0 | ||
26 | ``` | ||
27 | |||
28 | |||
29 | ### Run Franz Development App | ||
30 | Run these two commands __simultaneously__ in different console tabs. | ||
31 | |||
32 | ```bash | ||
33 | $ yarn run dev | ||
34 | $ yarn start | ||
35 | ``` | ||
36 | |||
37 | ## Packaging | ||
38 | ```bash | ||
39 | $ yarn build | ||
40 | ``` | ||
41 | |||
42 | ## How can I support the project? | ||
43 | If you have found a bug that hasn't been reported yet, please open a new issue. | ||
44 | |||
45 | ## I need help? | ||
46 | Join the Franz community on [Slack](https://slack.franz.im) and get in touch with us. | ||
47 | |||
48 | ## Next steps | ||
49 | - [ ] Create acceptance tests | ||
50 | - [ ] 5.0 stable release | ||
51 | - [ ] Developer Documentation | ||
52 | |||
53 | ## License | ||
54 | Franz 5 is open-source licensed under the GPLv2 License. | ||