diff options
author | vantezzen <hello@vantezzen.io> | 2019-10-21 18:05:55 +0200 |
---|---|---|
committer | vantezzen <hello@vantezzen.io> | 2019-10-21 18:05:55 +0200 |
commit | 6039ae14697032a331ccc4e23ab3ff04d70d7080 (patch) | |
tree | 0bbc16742ef28d12a7debcbc038c7a90a8b4cb5b /README.md | |
parent | Update feature list (diff) | |
parent | Fine-tune git submodules config (diff) | |
download | ferdium-app-6039ae14697032a331ccc4e23ab3ff04d70d7080.tar.gz ferdium-app-6039ae14697032a331ccc4e23ab3ff04d70d7080.tar.zst ferdium-app-6039ae14697032a331ccc4e23ab3ff04d70d7080.zip |
Merge branch 'develop' of https://github.com/getferdi/ferdi into develop
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 41 |
1 files changed, 31 insertions, 10 deletions
@@ -55,6 +55,27 @@ You can find the installers in the [latest release](https://github.com/getferdi/ | |||
55 | 55 | ||
56 | ### Preparations | 56 | ### Preparations |
57 | 57 | ||
58 | #### Install OS dependencies | ||
59 | |||
60 | ##### Debian/Ubuntu | ||
61 | |||
62 | ```bash | ||
63 | $ apt install libx11-dev libxext-dev libxss-dev libxkbfile-dev | ||
64 | ``` | ||
65 | |||
66 | ##### Fedora | ||
67 | |||
68 | ```bash | ||
69 | $ dnf install libX11-devel libXext-devel libXScrnSaver-devel libxkbfile-devel | ||
70 | ``` | ||
71 | |||
72 | ##### Windows | ||
73 | |||
74 | ```bash | ||
75 | $ npm install --global windows-build-tools // Windows 10 | ||
76 | $ npm install --global windows-build-tools --vs2015 // Windows 7 | ||
77 | ``` | ||
78 | |||
58 | #### Clone repository with submodule | 79 | #### Clone repository with submodule |
59 | 80 | ||
60 | ```bash | 81 | ```bash |
@@ -63,13 +84,11 @@ $ cd getferdi | |||
63 | $ git submodule update --init --recursive | 84 | $ git submodule update --init --recursive |
64 | ``` | 85 | ``` |
65 | 86 | ||
66 | #### Install Linux OS dependencies | 87 | It is important you execute the last command to get the required submodules (recipes, server). |
67 | |||
68 | [Guide: Linux distribution specific dependencies](docs/linux.md) | ||
69 | 88 | ||
70 | #### Use right NodeJS version | 89 | #### Use right NodeJS version |
71 | 90 | ||
72 | Please make sure you are running NodeJS v10 (v10.16.3 suggested). Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278) | 91 | Please make sure you are running NodeJS v10 (v10.16.3 suggested). Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278). |
73 | 92 | ||
74 | #### Fix native modules to match current electron node version | 93 | #### Fix native modules to match current electron node version |
75 | 94 | ||
@@ -79,7 +98,7 @@ $ npm run rebuild | |||
79 | 98 | ||
80 | ### Install dependencies | 99 | ### Install dependencies |
81 | 100 | ||
82 | Run the following command to install all dependencies, and link sibling modules with Franz. | 101 | Run the following command to install all dependencies, and link sibling modules with Ferdi. |
83 | 102 | ||
84 | ```bash | 103 | ```bash |
85 | $ npx lerna bootstrap | 104 | $ npx lerna bootstrap |
@@ -87,9 +106,9 @@ $ npx lerna bootstrap | |||
87 | 106 | ||
88 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. | 107 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. |
89 | 108 | ||
90 | ### Run Ferdi Development App | 109 | ### Start development app |
91 | 110 | ||
92 | Run these two commands **simultaneously** in different console tabs. | 111 | Run these two commands **simultaneously** in different console tabs: |
93 | 112 | ||
94 | ```bash | 113 | ```bash |
95 | $ npm run dev | 114 | $ npm run dev |
@@ -98,7 +117,7 @@ $ npm run start | |||
98 | 117 | ||
99 | Be aware that the development database will be reset regularly. | 118 | Be aware that the development database will be reset regularly. |
100 | 119 | ||
101 | ## Packaging | 120 | ### Packaging |
102 | 121 | ||
103 | ```bash | 122 | ```bash |
104 | $ npm run build | 123 | $ npm run build |
@@ -106,14 +125,16 @@ $ npm run build | |||
106 | 125 | ||
107 | Deliverables will be available in the `out` folder. | 126 | Deliverables will be available in the `out` folder. |
108 | 127 | ||
109 | ## Release | 128 | ### Release |
110 | 129 | ||
111 | ```bash | 130 | ```bash |
131 | $ git checkout develop && git pull && git checkout master | ||
132 | $ git merge --no-ff develop | ||
112 | $ git tag v5.3.4-beta.4 | 133 | $ git tag v5.3.4-beta.4 |
113 | $ git push --tags | 134 | $ git push --tags |
114 | ``` | 135 | ``` |
115 | 136 | ||
116 | When pushing a new tag, the CI build will create a draft GitHub release and upload the deliverables in the draft release assets. Wait for all the assets to be uploaded before publishing the draft release. | 137 | When pushing a new tag, the CI builds will create a draft GitHub release and upload the deliverables in the draft release assets. Wait for all the assets to be uploaded before publishing the draft release. |
117 | 138 | ||
118 | ## Contributors ✨ | 139 | ## Contributors ✨ |
119 | 140 | ||