diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 27 |
1 files changed, 26 insertions, 1 deletions
@@ -33,20 +33,36 @@ | |||
33 | - [Ferdi](#ferdi) | 33 | - [Ferdi](#ferdi) |
34 | - [Table of contents](#table-of-contents) | 34 | - [Table of contents](#table-of-contents) |
35 | - [What is Ferdi?](#what-is-ferdi) | 35 | - [What is Ferdi?](#what-is-ferdi) |
36 | - [Features](#features) | 36 | - [Features](#features) |
37 | - [What does Ferdi look like?](#what-does-ferdi-look-like) | 37 | - [What does Ferdi look like?](#what-does-ferdi-look-like) |
38 | - [Download Ferdi](#download-ferdi) | 38 | - [Download Ferdi](#download-ferdi) |
39 | - [Or use Chocolatey (Windows only)](#or-use-chocolatey-windows-only) | ||
39 | - [Or use homebrew (macOS only)](#or-use-homebrew-macos-only) | 40 | - [Or use homebrew (macOS only)](#or-use-homebrew-macos-only) |
40 | - [Or use AUR (Arch Linux)](#or-use-aur-arch-linux) | 41 | - [Or use AUR (Arch Linux)](#or-use-aur-arch-linux) |
41 | - [What makes Ferdi different from Franz?](#what-makes-ferdi-different-from-franz) | 42 | - [What makes Ferdi different from Franz?](#what-makes-ferdi-different-from-franz) |
43 | - [Removes unproductive paywalls and other other interruptions](#removes-unproductive-paywalls-and-other-other-interruptions) | ||
44 | - [Adds features to increase your productivity](#adds-features-to-increase-your-productivity) | ||
45 | - [Adds features to improve your privacy](#adds-features-to-improve-your-privacy) | ||
46 | - [Adds features to improve your experience using Ferdi](#adds-features-to-improve-your-experience-using-ferdi) | ||
47 | - [Removed bugs](#removed-bugs) | ||
48 | - [Adds new platforms](#adds-new-platforms) | ||
49 | - [Adds internal changes](#adds-internal-changes) | ||
42 | - [Development](#development) | 50 | - [Development](#development) |
43 | - [Install OS dependencies](#install-os-dependencies) | 51 | - [Install OS dependencies](#install-os-dependencies) |
52 | - [Node.js](#nodejs) | ||
53 | - [Git](#git) | ||
54 | - [Debian/Ubuntu](#debianubuntu) | ||
55 | - [Fedora](#fedora) | ||
56 | - [Windows](#windows) | ||
44 | - [Clone repository with submodule](#clone-repository-with-submodule) | 57 | - [Clone repository with submodule](#clone-repository-with-submodule) |
58 | - [Local caching of dependencies](#local-caching-of-dependencies) | ||
45 | - [Install dependencies](#install-dependencies) | 59 | - [Install dependencies](#install-dependencies) |
46 | - [Fix native modules to match current electron node version](#fix-native-modules-to-match-current-electron-node-version) | 60 | - [Fix native modules to match current electron node version](#fix-native-modules-to-match-current-electron-node-version) |
61 | - [Package recipe repository](#package-recipe-repository) | ||
47 | - [Start development app](#start-development-app) | 62 | - [Start development app](#start-development-app) |
48 | - [Packaging](#packaging) | 63 | - [Packaging](#packaging) |
49 | - [Release](#release) | 64 | - [Release](#release) |
65 | - [Nightly releases](#nightly-releases) | ||
50 | - [Contributors ✨](#contributors-) | 66 | - [Contributors ✨](#contributors-) |
51 | - [Backers via OpenCollective](#backers-via-opencollective) | 67 | - [Backers via OpenCollective](#backers-via-opencollective) |
52 | - [Sponsors via OpenCollective](#sponsors-via-opencollective) | 68 | - [Sponsors via OpenCollective](#sponsors-via-opencollective) |
@@ -249,6 +265,15 @@ $ git submodule update --init --recursive | |||
249 | 265 | ||
250 | It is important you execute the last command to get the required submodules (recipes, server). | 266 | It is important you execute the last command to get the required submodules (recipes, server). |
251 | 267 | ||
268 | |||
269 | ### Local caching of dependencies | ||
270 | |||
271 | Set these env vars into your profile (or if you use [direnv](https://direnv.net/), you can manage them via the respective `.envrc` file) | ||
272 | ```bash | ||
273 | export ELECTRON_CACHE=$HOME/.cache/electron | ||
274 | export ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder | ||
275 | ``` | ||
276 | |||
252 | ### Install dependencies | 277 | ### Install dependencies |
253 | 278 | ||
254 | Run the following command to install all dependencies, and link sibling modules with Ferdi. | 279 | Run the following command to install all dependencies, and link sibling modules with Ferdi. |