diff options
author | Aditya Mangalampalli <aditya.mangalampalli@gmail.com> | 2022-04-15 02:00:25 -0700 |
---|---|---|
committer | Vijay A <vraravam@users.noreply.github.com> | 2022-04-16 21:57:57 +0530 |
commit | 210131ca184c3aa043371857c022aa1aa149efbf (patch) | |
tree | 6bc4e10a1540e55a66146c099bc468a12287425e /CONTRIBUTING.md | |
parent | Update submodule url to ferdium-recipes (#1) (diff) | |
download | ferdium-app-210131ca184c3aa043371857c022aa1aa149efbf.tar.gz ferdium-app-210131ca184c3aa043371857c022aa1aa149efbf.tar.zst ferdium-app-210131ca184c3aa043371857c022aa1aa149efbf.zip |
Matched casing for almost all replacements
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a379f80dd..081066fee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -1,12 +1,12 @@ | |||
1 | # Contributing to Ferdi 5 | 1 | # Contributing to Ferdium 5 |
2 | 2 | ||
3 | :tada: First off, thanks for taking the time and your effort to make Ferdi better! :tada: | 3 | :tada: First off, thanks for taking the time and your effort to make Ferdium better! :tada: |
4 | 4 | ||
5 | ## Table of contents | 5 | ## Table of contents |
6 | 6 | ||
7 | <!-- TOC depthFrom:2 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 --> | 7 | <!-- TOC depthFrom:2 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 --> |
8 | 8 | ||
9 | - [Contributing to Ferdi 5](#contributing-to-ferdi-5) | 9 | - [Contributing to Ferdium 5](#contributing-to-ferdium-5) |
10 | - [Table of contents](#table-of-contents) | 10 | - [Table of contents](#table-of-contents) |
11 | - [Code of Conduct](#code-of-conduct) | 11 | - [Code of Conduct](#code-of-conduct) |
12 | - [What should I know before I get started?](#what-should-i-know-before-i-get-started) | 12 | - [What should I know before I get started?](#what-should-i-know-before-i-get-started) |
@@ -38,11 +38,11 @@ | |||
38 | 38 | ||
39 | ## Code of Conduct | 39 | ## Code of Conduct |
40 | 40 | ||
41 | This project and everyone participating in it is governed by the [Ferdi Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [hello@getferdi.com](mailto:hello@getferdi.com). | 41 | This project and everyone participating in it is governed by the [Ferdium Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [hello@ferdium.org](mailto:hello@ferdium.org). |
42 | 42 | ||
43 | ## What should I know before I get started? | 43 | ## What should I know before I get started? |
44 | 44 | ||
45 | For the moment, Ferdi's development is a bit slow but all contributions are highly appreciated. [Check this issue for discussion](https://github.com/getferdi/ferdi/issues/956). | 45 | For the moment, Ferdium's development is a bit slow but all contributions are highly appreciated. [Check this issue for discussion](https://github.com/ferdium/ferdium-app/issues/956). |
46 | 46 | ||
47 | ## How Can I Contribute? | 47 | ## How Can I Contribute? |
48 | 48 | ||
@@ -98,8 +98,8 @@ npm i -g windows-build-tools --vs2015 | |||
98 | ### Clone repository with submodule | 98 | ### Clone repository with submodule |
99 | 99 | ||
100 | ```bash | 100 | ```bash |
101 | git clone https://github.com/getferdi/ferdi.git | 101 | git clone https://github.com/ferdium/ferdium.git |
102 | cd ferdi | 102 | cd ferdium |
103 | git submodule update --init --recursive --remote --rebase --force | 103 | git submodule update --init --recursive --remote --rebase --force |
104 | ``` | 104 | ``` |
105 | 105 | ||
@@ -116,7 +116,7 @@ export ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder | |||
116 | 116 | ||
117 | ### Install dependencies | 117 | ### Install dependencies |
118 | 118 | ||
119 | Run the following command to install all dependencies, and link sibling modules with Ferdi. | 119 | Run the following command to install all dependencies, and link sibling modules with Ferdium. |
120 | 120 | ||
121 | ```bash | 121 | ```bash |
122 | npm i | 122 | npm i |
@@ -132,7 +132,7 @@ npm run build | |||
132 | 132 | ||
133 | ### Package recipe repository | 133 | ### Package recipe repository |
134 | 134 | ||
135 | Ferdi requires its recipes to be packaged before it can use it. When running Ferdi as a development instance, you'll need to package the local recipes before you can create any services inside Ferdi. | 135 | Ferdium requires its recipes to be packaged before it can use it. When running Ferdium as a development instance, you'll need to package the local recipes before you can create any services inside Ferdium. |
136 | 136 | ||
137 | ```bash | 137 | ```bash |
138 | cd recipes && pnpm i && pnpm run package | 138 | cd recipes && pnpm i && pnpm run package |
@@ -141,25 +141,25 @@ cd recipes && pnpm i && pnpm run package | |||
141 | ### Using Docker to build a linux-targetted packaged app | 141 | ### Using Docker to build a linux-targetted packaged app |
142 | 142 | ||
143 | ```bash | 143 | ```bash |
144 | docker build -t ferdi-package-`uname -m` . | 144 | docker build -t ferdium-package-`uname -m` . |
145 | ``` | 145 | ``` |
146 | 146 | ||
147 | The above will place all the built artifacts into the `/ferdi` folder within the image. | 147 | The above will place all the built artifacts into the `/ferdium` folder within the image. |
148 | 148 | ||
149 | If you want to copy them outside of the image, simply mount a volume into a different location, and copy all files from `/ferdi` into the mounted folder (`/ferdi-out` in the example command below). | 149 | If you want to copy them outside of the image, simply mount a volume into a different location, and copy all files from `/ferdium` into the mounted folder (`/ferdium-out` in the example command below). |
150 | 150 | ||
151 | ```bash | 151 | ```bash |
152 | DATE=`date +"%Y-%b-%d-%H-%M"` | 152 | DATE=`date +"%Y-%b-%d-%H-%M"` |
153 | mkdir -p ~/Downloads/$DATE | 153 | mkdir -p ~/Downloads/$DATE |
154 | docker run -e GIT_SHA=`git rev-parse --short HEAD` -v ~/Downloads/$DATE:/ferdi-out -it ferdi-package sh | 154 | docker run -e GIT_SHA=`git rev-parse --short HEAD` -v ~/Downloads/$DATE:/ferdium-out -it ferdium-package sh |
155 | # inside the container: | 155 | # inside the container: |
156 | mv /ferdi/Ferdi-*.AppImage /ferdi-out/Ferdi-$GIT_SHA.AppImage | 156 | mv /ferdium/Ferdium-*.AppImage /ferdium-out/Ferdium-$GIT_SHA.AppImage |
157 | mv /ferdi/ferdi-*.tar.gz /ferdi-out/Ferdi-$GIT_SHA.tar.gz | 157 | mv /ferdium/ferdium-*.tar.gz /ferdium-out/Ferdium-$GIT_SHA.tar.gz |
158 | mv /ferdi/ferdi-*.x86_64.rpm /ferdi-out/Ferdi-x86_64-$GIT_SHA.rpm | 158 | mv /ferdium/ferdium-*.x86_64.rpm /ferdium-out/Ferdium-x86_64-$GIT_SHA.rpm |
159 | mv /ferdi/ferdi_*_amd64.deb /ferdi-out/Ferdi-amd64-$GIT_SHA.deb | 159 | mv /ferdium/ferdium_*_amd64.deb /ferdium-out/Ferdium-amd64-$GIT_SHA.deb |
160 | mv /ferdi/ferdi-*.freebsd /ferdi-out/Ferdi-$GIT_SHA.freebsd | 160 | mv /ferdium/ferdium-*.freebsd /ferdium-out/Ferdium-$GIT_SHA.freebsd |
161 | mv /ferdi/ferdi /ferdi-out/Ferdi-$GIT_SHA | 161 | mv /ferdium/ferdium /ferdium-out/Ferdium-$GIT_SHA |
162 | mv /ferdi/latest-linux.yml /ferdi-out/latest-linux-$GIT_SHA.yml | 162 | mv /ferdium/latest-linux.yml /ferdium-out/latest-linux-$GIT_SHA.yml |
163 | ``` | 163 | ``` |
164 | 164 | ||
165 | ### Code Signing on a mac | 165 | ### Code Signing on a mac |
@@ -182,13 +182,13 @@ Run these two commands **simultaneously** in different terminals: | |||
182 | 182 | ||
183 | ```bash | 183 | ```bash |
184 | npm run dev | 184 | npm run dev |
185 | DEBUG=Ferdi:* npm run start | 185 | DEBUG=Ferdium:* npm run start |
186 | ``` | 186 | ``` |
187 | 187 | ||
188 | - Optionally, you can run both commands in one terminal with [concurrently](https://www.npmjs.com/package/concurrently): | 188 | - Optionally, you can run both commands in one terminal with [concurrently](https://www.npmjs.com/package/concurrently): |
189 | 189 | ||
190 | ```bash | 190 | ```bash |
191 | DEBUG_COLORS=1 DEBUG=Ferdi:* npm run start:all-dev | 191 | DEBUG_COLORS=1 DEBUG=Ferdium:* npm run start:all-dev |
192 | ``` | 192 | ``` |
193 | 193 | ||
194 | Note: please prefer [`debug()`](https://github.com/visionmedia/debug) over `console.log()`. | 194 | Note: please prefer [`debug()`](https://github.com/visionmedia/debug) over `console.log()`. |
@@ -228,11 +228,11 @@ git merge --no-ff nightly --no-verify | |||
228 | git push | 228 | git push |
229 | ``` | 229 | ``` |
230 | 230 | ||
231 | This will automatically trigger the build, as part of which, a new, draft release will be created [here](https://github.com/getferdi/ferdi/releases/). Once all the assets are uploaded (19 assets in total), publish the release (you will need elevated permissions in GitHub for doing this). The last commit of the `release` branch will be tagged. | 231 | This will automatically trigger the build, as part of which, a new, draft release will be created [here](https://github.com/ferdium/ferdium-app/releases/). Once all the assets are uploaded (19 assets in total), publish the release (you will need elevated permissions in GitHub for doing this). The last commit of the `release` branch will be tagged. |
232 | 232 | ||
233 | ### Nightly releases | 233 | ### Nightly releases |
234 | 234 | ||
235 | Nightly releases are automatically triggered every day ([details](https://github.com/getferdi/ferdi/pull/990)) and available in [getferdi/ferdi](https://github.com/getferdi/ferdi/releases). Maintainers still need to verify and manually publish the draft releases as pre-releases for now. | 235 | Nightly releases are automatically triggered every day ([details](https://github.com/ferdium/ferdium-app/pull/990)) and available in [ferdium/ferdium](https://github.com/ferdium/ferdium-app/releases). Maintainers still need to verify and manually publish the draft releases as pre-releases for now. |
236 | 236 | ||
237 | ### Updating the code after a hiatus | 237 | ### Updating the code after a hiatus |
238 | 238 | ||