diff options
author | Amine Mouafik <amine@mouafik.fr> | 2019-10-21 16:46:11 +0700 |
---|---|---|
committer | Amine Mouafik <amine@mouafik.fr> | 2019-10-21 16:46:11 +0700 |
commit | 69cf74a58b9dc539d53a484e6eadca73fa9accf9 (patch) | |
tree | c324cd9e15a5270d3c3770f347afc7db9b7b6280 | |
parent | Merge pull request #137 from getferdi/l10n_develop (diff) | |
download | ferdium-app-69cf74a58b9dc539d53a484e6eadca73fa9accf9.tar.gz ferdium-app-69cf74a58b9dc539d53a484e6eadca73fa9accf9.tar.zst ferdium-app-69cf74a58b9dc539d53a484e6eadca73fa9accf9.zip |
#145 Review development instructions
-rw-r--r-- | README.md | 41 | ||||
-rw-r--r-- | docs/linux.md | 11 |
2 files changed, 31 insertions, 21 deletions
@@ -54,6 +54,27 @@ You can find the installers in the [latest release](https://github.com/getferdi/ | |||
54 | 54 | ||
55 | ### Preparations | 55 | ### Preparations |
56 | 56 | ||
57 | #### Install OS dependencies | ||
58 | |||
59 | ##### Debian/Ubuntu | ||
60 | |||
61 | ```bash | ||
62 | $ apt install libx11-dev libxext-dev libxss-dev libxkbfile-dev | ||
63 | ``` | ||
64 | |||
65 | ##### Fedora | ||
66 | |||
67 | ```bash | ||
68 | $ dnf install libX11-devel libXext-devel libXScrnSaver-devel libxkbfile-devel | ||
69 | ``` | ||
70 | |||
71 | ##### Windows | ||
72 | |||
73 | ```bash | ||
74 | $ npm install --global windows-build-tools // Windows 10 | ||
75 | $ npm install --global windows-build-tools --vs2015 // Windows 7 | ||
76 | ``` | ||
77 | |||
57 | #### Clone repository with submodule | 78 | #### Clone repository with submodule |
58 | 79 | ||
59 | ```bash | 80 | ```bash |
@@ -62,13 +83,11 @@ $ cd getferdi | |||
62 | $ git submodule update --init --recursive | 83 | $ git submodule update --init --recursive |
63 | ``` | 84 | ``` |
64 | 85 | ||
65 | #### Install Linux OS dependencies | 86 | It is important you execute the last command to get the required submodules (recipes, server). |
66 | |||
67 | [Guide: Linux distribution specific dependencies](docs/linux.md) | ||
68 | 87 | ||
69 | #### Use right NodeJS version | 88 | #### Use right NodeJS version |
70 | 89 | ||
71 | 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) | 90 | 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). |
72 | 91 | ||
73 | #### Fix native modules to match current electron node version | 92 | #### Fix native modules to match current electron node version |
74 | 93 | ||
@@ -78,7 +97,7 @@ $ npm run rebuild | |||
78 | 97 | ||
79 | ### Install dependencies | 98 | ### Install dependencies |
80 | 99 | ||
81 | Run the following command to install all dependencies, and link sibling modules with Franz. | 100 | Run the following command to install all dependencies, and link sibling modules with Ferdi. |
82 | 101 | ||
83 | ```bash | 102 | ```bash |
84 | $ npx lerna bootstrap | 103 | $ npx lerna bootstrap |
@@ -86,9 +105,9 @@ $ npx lerna bootstrap | |||
86 | 105 | ||
87 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. | 106 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. |
88 | 107 | ||
89 | ### Run Ferdi Development App | 108 | ### Start development app |
90 | 109 | ||
91 | Run these two commands **simultaneously** in different console tabs. | 110 | Run these two commands **simultaneously** in different console tabs: |
92 | 111 | ||
93 | ```bash | 112 | ```bash |
94 | $ npm run dev | 113 | $ npm run dev |
@@ -97,7 +116,7 @@ $ npm run start | |||
97 | 116 | ||
98 | Be aware that the development database will be reset regularly. | 117 | Be aware that the development database will be reset regularly. |
99 | 118 | ||
100 | ## Packaging | 119 | ### Packaging |
101 | 120 | ||
102 | ```bash | 121 | ```bash |
103 | $ npm run build | 122 | $ npm run build |
@@ -105,14 +124,16 @@ $ npm run build | |||
105 | 124 | ||
106 | Deliverables will be available in the `out` folder. | 125 | Deliverables will be available in the `out` folder. |
107 | 126 | ||
108 | ## Release | 127 | ### Release |
109 | 128 | ||
110 | ```bash | 129 | ```bash |
130 | $ git checkout develop && git pull && git checkout master | ||
131 | $ git merge --no-ff develop | ||
111 | $ git tag v5.3.4-beta.4 | 132 | $ git tag v5.3.4-beta.4 |
112 | $ git push --tags | 133 | $ git push --tags |
113 | ``` | 134 | ``` |
114 | 135 | ||
115 | 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. | 136 | 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. |
116 | 137 | ||
117 | ## Contributors ✨ | 138 | ## Contributors ✨ |
118 | 139 | ||
diff --git a/docs/linux.md b/docs/linux.md deleted file mode 100644 index 43ffa313b..000000000 --- a/docs/linux.md +++ /dev/null | |||
@@ -1,11 +0,0 @@ | |||
1 | # Linux distribution specific dependencies | ||
2 | |||
3 | ## Debian/Ubuntu | ||
4 | ```bash | ||
5 | $ apt install libx11-dev libxext-dev libxss-dev libxkbfile-dev | ||
6 | ``` | ||
7 | |||
8 | ## Fedora | ||
9 | ```bash | ||
10 | $ dnf install libX11-devel libXext-devel libXScrnSaver-devel libxkbfile-devel | ||
11 | ``` | ||