diff options
-rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
@@ -13,13 +13,13 @@ | |||
13 | 13 | ||
14 | 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. | 14 | 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. |
15 | 15 | ||
16 | #### Table of contents | 16 | ### Table of contents |
17 | 17 | ||
18 | <details> | 18 | <details> |
19 | <summary>Ferdi</summary> | 19 | <summary>Ferdi</summary> |
20 | <ul> | 20 | <ul> |
21 | <li><a href="#what-is-ferdi">What is Ferdi ?</a></li> | 21 | <li><a href="#what-is-ferdi-">What is Ferdi ?</a></li> |
22 | <li><a href="#what-ferdi-looks-like">What Ferdi looks like ?</a></li> | 22 | <li><a href="#what-ferdi-looks-like-">What Ferdi looks like ?</a></li> |
23 | <li><a href="#download-ferdi">Download Ferdi</a> | 23 | <li><a href="#download-ferdi">Download Ferdi</a> |
24 | <ul> | 24 | <ul> |
25 | <li><a href="#or-use-homebrew-macos-only">Or use homebrew</a></li> | 25 | <li><a href="#or-use-homebrew-macos-only">Or use homebrew</a></li> |
@@ -27,7 +27,7 @@ | |||
27 | </li> | 27 | </li> |
28 | <li><a href="#ferdi-specific-features">Ferdi-specific Features</a></li> | 28 | <li><a href="#ferdi-specific-features">Ferdi-specific Features</a></li> |
29 | <li><a href="#development">Development</a></li> | 29 | <li><a href="#development">Development</a></li> |
30 | <li><a href="#contributors">Contributors ✨</a></li> | 30 | <li><a href="#contributors-">Contributors ✨</a></li> |
31 | <li><a href="#backers-via-opencollective">Backers via OpenCollective</a></li> | 31 | <li><a href="#backers-via-opencollective">Backers via OpenCollective</a></li> |
32 | <li><a href="#sponsors-via-opencollective">Sponsors via OpenCollective</a></li> | 32 | <li><a href="#sponsors-via-opencollective">Sponsors via OpenCollective</a></li> |
33 | </ul> | 33 | </ul> |
@@ -49,7 +49,7 @@ Ferdi is based on Franz - a messaging browser already used by thousands of peopl | |||
49 | 49 | ||
50 | ## Download Ferdi | 50 | ## Download Ferdi |
51 | 51 | ||
52 | You can find the installers in the [latest stable release](https://github.com/getferdi/ferdi/releases/latest) assets and the [pre-release ones here](https://github.com/getferdi/ferdi/releases). | 52 | You can find the installers in the [latest stable release](https://github.com/getferdi/ferdi/releases/latest) assets and [all the release here](https://github.com/getferdi/ferdi/releases). |
53 | 53 | ||
54 | ### Or use homebrew (macOS only) | 54 | ### Or use homebrew (macOS only) |
55 | 55 | ||
@@ -122,7 +122,7 @@ $ npm install --global windows-build-tools // Windows 10 | |||
122 | $ npm install --global windows-build-tools --vs2015 // Windows 7 | 122 | $ npm install --global windows-build-tools --vs2015 // Windows 7 |
123 | ``` | 123 | ``` |
124 | 124 | ||
125 | #### Clone repository with submodule | 125 | ### Clone repository with submodule |
126 | 126 | ||
127 | ```bash | 127 | ```bash |
128 | $ git clone https://github.com/getferdi/ferdi.git | 128 | $ git clone https://github.com/getferdi/ferdi.git |
@@ -132,7 +132,7 @@ $ git submodule update --init --recursive | |||
132 | 132 | ||
133 | It is important you execute the last command to get the required submodules (recipes, server). | 133 | It is important you execute the last command to get the required submodules (recipes, server). |
134 | 134 | ||
135 | #### Install dependencies | 135 | ### Install dependencies |
136 | 136 | ||
137 | Run the following command to install all dependencies, and link sibling modules with Ferdi. | 137 | Run the following command to install all dependencies, and link sibling modules with Ferdi. |
138 | 138 | ||
@@ -142,13 +142,13 @@ $ npx lerna bootstrap | |||
142 | 142 | ||
143 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. | 143 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. |
144 | 144 | ||
145 | #### Fix native modules to match current electron node version | 145 | ### Fix native modules to match current electron node version |
146 | 146 | ||
147 | ```bash | 147 | ```bash |
148 | $ npm run rebuild | 148 | $ npm run rebuild |
149 | ``` | 149 | ``` |
150 | 150 | ||
151 | #### Start development app | 151 | ### Start development app |
152 | 152 | ||
153 | Run these two commands **simultaneously** in different console tabs: | 153 | Run these two commands **simultaneously** in different console tabs: |
154 | 154 | ||
@@ -159,7 +159,7 @@ $ npm run start | |||
159 | 159 | ||
160 | Be aware that the development database will be reset regularly. | 160 | Be aware that the development database will be reset regularly. |
161 | 161 | ||
162 | #### Packaging | 162 | ### Packaging |
163 | 163 | ||
164 | ```bash | 164 | ```bash |
165 | $ npm run build | 165 | $ npm run build |
@@ -167,7 +167,7 @@ $ npm run build | |||
167 | 167 | ||
168 | Deliverables will be available in the `out` folder. | 168 | Deliverables will be available in the `out` folder. |
169 | 169 | ||
170 | #### Release | 170 | ### Release |
171 | 171 | ||
172 | ```bash | 172 | ```bash |
173 | $ git checkout develop && git pull && git checkout master | 173 | $ git checkout develop && git pull && git checkout master |