aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 31 insertions, 23 deletions
diff --git a/README.md b/README.md
index 1f50307ba..f7eb28fac 100644
--- a/README.md
+++ b/README.md
@@ -17,29 +17,31 @@
17 17
18<details> 18<details>
19<summary>Toggle navigation</summary> 19<summary>Toggle navigation</summary>
20<ul> 20
21<li><a href="#what-is-ferdi">What is Ferdi?</a></li> 21- [Ferdi](#ferdi)
22<li><a href="#what-does-ferdi-look-like">What does Ferdi look like?</a></li> 22 - [Table of contents](#table-of-contents)
23<li><a href="#download-ferdi">Download Ferdi</a> 23 - [What is Ferdi?](#what-is-ferdi)
24<ul> 24 - [What does Ferdi look like?](#what-does-ferdi-look-like)
25<li><a href="#or-use-homebrew-macos-only">Or use homebrew</a></li> 25 - [Download Ferdi](#download-ferdi)
26</ul> 26 - [Or use homebrew (macOS only)](#or-use-homebrew-macos-only)
27</li> 27 - [Or use AUR (Arch Linux)](#or-use-aur-arch-linux)
28<li><a href="#ferdi-specific-features">Ferdi-specific features</a></li> 28 - [Ferdi-specific Features](#ferdi-specific-features)
29<li><a href="#development">Development</a></li> 29 - [Development](#development)
30<ul> 30 - [Install OS dependencies](#install-os-dependencies)
31<li><a href="#install-os-dependencies">Install OS dependencies</a></li> 31 - [Node.js](#nodejs)
32<li><a href="#clone-repository-with-submodule">Clone repository with submodule</a></li> 32 - [Git](#git)
33<li><a href="#install-dependencies">Install dependencies</a></li> 33 - [Debian/Ubuntu](#debianubuntu)
34<li><a href="#fix-native-modules-to-match-current-electron-node-version">Fix native modules to match current electron node version</a></li> 34 - [Fedora](#fedora)
35<li><a href="#start-development-app">Start development app</a></li> 35 - [Windows](#windows)
36<li><a href="#packaging">Packaging</a></li> 36 - [Clone repository with submodule](#clone-repository-with-submodule)
37<li><a href="#release">Release</a></li> 37 - [Install dependencies](#install-dependencies)
38</ul> 38 - [Fix native modules to match current electron node version](#fix-native-modules-to-match-current-electron-node-version)
39<li><a href="#contributors-">Contributors ✨</a></li> 39 - [Start development app](#start-development-app)
40<li><a href="#backers-via-opencollective">Backers via OpenCollective</a></li> 40 - [Packaging](#packaging)
41<li><a href="#sponsors-via-opencollective">Sponsors via OpenCollective</a></li> 41 - [Release](#release)
42</ul> 42 - [Contributors ✨](#contributors-%e2%9c%a8)
43 - [Backers via OpenCollective](#backers-via-opencollective)
44 - [Sponsors via OpenCollective](#sponsors-via-opencollective)
43</details> 45</details>
44 46
45### What is Ferdi? 47### What is Ferdi?
@@ -196,6 +198,8 @@ Deliverables will be available in the `out` folder.
196```bash 198```bash
197$ git checkout develop && git pull 199$ git checkout develop && git pull
198$ git submodule update --remote --force 200$ git submodule update --remote --force
201$ git add .
202$ git commit -m "Update submodules"
199$ git checkout master 203$ git checkout master
200$ git merge --no-ff develop 204$ git merge --no-ff develop
201$ git tag v5.3.4-beta.4 205$ git tag v5.3.4-beta.4
@@ -242,6 +246,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
242 <td align="center"><a href="https://github.com/steliyan"><img src="https://avatars1.githubusercontent.com/u/1850292?v=4" width="40px;" alt=""/><br /><sub><b>Steliyan Stoyanov</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=steliyan" title="Code">💻</a> <a href="#ideas-steliyan" title="Ideas, Planning, & Feedback">🤔</a></td> 246 <td align="center"><a href="https://github.com/steliyan"><img src="https://avatars1.githubusercontent.com/u/1850292?v=4" width="40px;" alt=""/><br /><sub><b>Steliyan Stoyanov</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=steliyan" title="Code">💻</a> <a href="#ideas-steliyan" title="Ideas, Planning, & Feedback">🤔</a></td>
243 <td align="center"><a href="https://github.com/brorbw"><img src="https://avatars2.githubusercontent.com/u/5909562?v=4" width="40px;" alt=""/><br /><sub><b>Bror Winther</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=brorbw" title="Documentation">📖</a></td> 247 <td align="center"><a href="https://github.com/brorbw"><img src="https://avatars2.githubusercontent.com/u/5909562?v=4" width="40px;" alt=""/><br /><sub><b>Bror Winther</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=brorbw" title="Documentation">📖</a></td>
244 <td align="center"><a href="https://fwdekker.com/"><img src="https://avatars0.githubusercontent.com/u/13442533?v=4" width="40px;" alt=""/><br /><sub><b>Felix W. Dekker</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=FWDekker" title="Documentation">📖</a></td> 248 <td align="center"><a href="https://fwdekker.com/"><img src="https://avatars0.githubusercontent.com/u/13442533?v=4" width="40px;" alt=""/><br /><sub><b>Felix W. Dekker</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=FWDekker" title="Documentation">📖</a></td>
249 <td align="center"><a href="https://github.com/Sauceee"><img src="https://avatars2.githubusercontent.com/u/17987941?v=4" width="40px;" alt=""/><br /><sub><b>Sauceee</b></sub></a><br /><a href="#design-Sauceee" title="Design">🎨</a></td>
250 </tr>
251 <tr>
252 <td align="center"><a href="http://lhw.ring0.de"><img src="https://avatars2.githubusercontent.com/u/351875?v=4" width="40px;" alt=""/><br /><sub><b>Lennart Weller</b></sub></a><br /><a href="#platform-lhw" title="Packaging/porting to new platform">📦</a></td>
245 </tr> 253 </tr>
246</table> 254</table>
247 255