From 08e45672cde96729a99a7455ebb979b5091dbd8c Mon Sep 17 00:00:00 2001 From: Amine Mouafik Date: Tue, 10 Sep 2019 09:00:37 +0700 Subject: Review instructions for installation/installers --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b2ee68a9f..7b7b93f45 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,16 @@ 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features. +## Installation + +For macOS: + +``` +brew cask install ferdi +``` + +Alternatively, and for Linux/Windows, you can find the installers in the [latest release](https://github.com/kytwb/ferdi/releases) assets. + ## Features - [x] Removes the counter-productive fullscreen app delay inviting users to upgrade - [x] Removes pages begging you to donate after registration @@ -33,11 +43,13 @@ $ npm run build Deliverables will be available in the `./out` folder. ## Developing + ### Preparations - [Install Linux dependencies](docs/linux.md) if you are developing on Linux - 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) ### Setup + 1. Fix native modules to match current electron node version ``` npm run rebuild @@ -53,10 +65,6 @@ Deliverables will be available in the `./out` folder. npm run start ``` -## Releases - -You 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. - ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): -- cgit v1.2.3-54-g00ecf