diff options
author | Amine Mouafik <amine@mouafik.fr> | 2019-09-10 09:00:37 +0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-10 09:00:37 +0700 |
commit | 08e45672cde96729a99a7455ebb979b5091dbd8c (patch) | |
tree | be4eb7501be5f9ef54f1b5fd83677383de487049 /README.md | |
parent | Update CHANGELOG.md (diff) | |
download | ferdium-app-08e45672cde96729a99a7455ebb979b5091dbd8c.tar.gz ferdium-app-08e45672cde96729a99a7455ebb979b5091dbd8c.tar.zst ferdium-app-08e45672cde96729a99a7455ebb979b5091dbd8c.zip |
Review instructions for installation/installers
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 16 |
1 files changed, 12 insertions, 4 deletions
@@ -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 | |||
11 | For macOS: | ||
12 | |||
13 | ``` | ||
14 | brew cask install ferdi | ||
15 | ``` | ||
16 | |||
17 | Alternatively, 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 |
@@ -33,11 +43,13 @@ $ npm run build | |||
33 | Deliverables will be available in the `./out` folder. | 43 | Deliverables will be available in the `./out` folder. |
34 | 44 | ||
35 | ## Developing | 45 | ## Developing |
46 | |||
36 | ### Preparations | 47 | ### Preparations |
37 | - [Install Linux dependencies](docs/linux.md) if you are developing on Linux | 48 | - [Install Linux dependencies](docs/linux.md) if you are developing on Linux |
38 | - 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) | 49 | - 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) |
39 | 50 | ||
40 | ### Setup | 51 | ### Setup |
52 | |||
41 | 1. Fix native modules to match current electron node version | 53 | 1. Fix native modules to match current electron node version |
42 | ``` | 54 | ``` |
43 | npm run rebuild | 55 | npm run rebuild |
@@ -53,10 +65,6 @@ Deliverables will be available in the `./out` folder. | |||
53 | npm run start | 65 | npm run start |
54 | ``` | 66 | ``` |
55 | 67 | ||
56 | ## Releases | ||
57 | |||
58 | 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. | ||
59 | |||
60 | ## Contributors ✨ | 68 | ## Contributors ✨ |
61 | 69 | ||
62 | Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | 70 | Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): |