aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Amine Mouafik <amine@mouafik.fr>2019-09-10 16:42:56 +0700
committerLibravatar Amine Mouafik <amine@mouafik.fr>2019-09-10 16:42:56 +0700
commitc0bef2195bba2457a98d2ba4f27bd5e7cd517305 (patch)
tree3f3681e911b7dfa7f2d1e1c2a29d17c94392dec4 /README.md
parentMerge branch 'master' of https://github.com/meetfranz/franz into franz-5.3.0 (diff)
parentReview instructions for installation/installers (diff)
downloadferdium-app-c0bef2195bba2457a98d2ba4f27bd5e7cd517305.tar.gz
ferdium-app-c0bef2195bba2457a98d2ba4f27bd5e7cd517305.tar.zst
ferdium-app-c0bef2195bba2457a98d2ba4f27bd5e7cd517305.zip
Merge branch 'master' into franz-5.3.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index c4f3f7554..ec1ca39f4 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,16 @@
6 6
7🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features. 7🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features.
8 8
9## Installation
10
11For macOS:
12
13```
14brew cask install ferdi
15```
16
17Alternatively, and for Linux/Windows, you can find the installers in the [latest release](https://github.com/kytwb/ferdi/releases) assets.
18
9## Features 19## Features
10- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade 20- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade
11- [x] Removes pages begging you to donate after registration 21- [x] Removes pages begging you to donate after registration
@@ -40,11 +50,13 @@ $ npm run build
40Deliverables will be available in the `./out` folder. 50Deliverables will be available in the `./out` folder.
41 51
42## Developing 52## Developing
53
43### Preparations 54### Preparations
44- [Install Linux dependencies](docs/linux.md) if you are developing on Linux 55- [Install Linux dependencies](docs/linux.md) if you are developing on Linux
45- Make sure you are running NodeJS v10. Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278) 56- Make sure you are running NodeJS v10. Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278)
46 57
47### Setup 58### Setup
59
481. Fix native modules to match current electron node version 601. Fix native modules to match current electron node version
49 ``` 61 ```
50 npm run rebuild 62 npm run rebuild
@@ -60,10 +72,6 @@ Deliverables will be available in the `./out` folder.
60 npm run start 72 npm run start
61 ``` 73 ```
62 74
63## Releases
64
65You can find the binaries for Linux, MacOS and Windows in the [latest release](https://github.com/kytwb/Ferdi/releases/tag/Ferdi-5.2.0-beta.3) assets. Assets are continuously delivered through [Travis](https://travis-ci.org/kytwb/Ferdi) for Linux/MacOS and [Appveyor](https://ci.appveyor.com/project/kytwb/Ferdi) for Windows.
66
67## Contributors ✨ 75## Contributors ✨
68 76
69Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): 77Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):