diff options
-rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
@@ -20,6 +20,27 @@ $ npm run build | |||
20 | 20 | ||
21 | Deliverables will be available in the `./out` folder. | 21 | Deliverables will be available in the `./out` folder. |
22 | 22 | ||
23 | ## Developing | ||
24 | ### Preparations | ||
25 | - [Install Linux dependencies](docs/linux.md) if you are developing on Linux | ||
26 | - 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) | ||
27 | |||
28 | ### Setup | ||
29 | 1. Fix native modules to match current electron node version | ||
30 | ``` | ||
31 | npm run rebuild | ||
32 | ``` | ||
33 | 2. Install dependencies using lerna | ||
34 | ``` | ||
35 | npx lerna bootstrap | ||
36 | ``` | ||
37 | 3. Run Ferdi Development App | ||
38 | Run these two commands *simultaneously* in different console tabs. | ||
39 | ``` | ||
40 | npm run dev | ||
41 | npm run start | ||
42 | ``` | ||
43 | |||
23 | ## Releases | 44 | ## Releases |
24 | 45 | ||
25 | 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. | 46 | 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. |