mirror of
https://github.com/BewlyBewly/BewlyBewly.git
synced 2025-04-14 13:15:29 +00:00
docs: add Firefox development section && correct the grammar
This commit is contained in:
Hakadao
@@ -65,7 +65,12 @@
|
||||
|
||||
## 🔧 开发 & 构建
|
||||
|
||||
### 开发
|
||||
### Chrome or Edge browser
|
||||
|
||||
<details>
|
||||
<summary>Chrome or Edge browser</summary>
|
||||
|
||||
#### 开发 (Chrome or Edge)
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
@@ -74,7 +79,7 @@ pnpm dev
|
||||
然后**在浏览器中使用 `加载已解压的拓展程序` 加载 `extension` 文件夹**。
|
||||
每次修改后，您需要单击 [重新加载](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) 按钮并刷新页面以确保应用更改。
|
||||
|
||||
### 构建
|
||||
#### 构建 (Chrome or Edge)
|
||||
|
||||
要构建拓展程序，运行
|
||||
|
||||
@@ -84,15 +89,45 @@ pnpm build
|
||||
|
||||
然后打包到 `extension` 文件夹
|
||||
|
||||
### 🤝 贡献
|
||||
</details>
|
||||
|
||||
#### 关于分支
|
||||
### Firefox browser
|
||||
|
||||
在此之前，请使用 `dev-firefox` 分支来执行以下操作。它可能包含一些错误或不清晰的代码，欢迎您帮助解决这些问题！:D
|
||||
|
||||
<details>
|
||||
<summary>Firefox</summary>
|
||||
|
||||
#### 开发 (Firefox)
|
||||
|
||||
```bash
|
||||
pnpm dev-firefox
|
||||
```
|
||||
|
||||
然后**在浏览器中使用 `加载已解压的拓展程序` 加载 `extension-firefox/` 文件夹**。
|
||||
每次修改后，您需要单击 [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) 按钮并刷新页面以确保应用更改。
|
||||
|
||||
#### 构建 (Firefox)
|
||||
|
||||
要构建拓展程序，运行
|
||||
|
||||
```bash
|
||||
pnpm build-firefox
|
||||
```
|
||||
|
||||
然后打包到 `extension-firefox` 文件夹
|
||||
|
||||
</details>
|
||||
|
||||
## 🤝 贡献
|
||||
|
||||
### 关于分支
|
||||
|
||||
- **Main**: 此分支用于只涉及文档文件（如 README 文件）的更改，不改变代码或其功能。
|
||||
- **Dev**: 用此分支进行新功能的开发、性能改进或对国际化（i18n）文件的修改。
|
||||
- **Bugfixes**: 此分支专门用于修复 main 分支中出现的错误。
|
||||
|
||||
#### I18n
|
||||
### I18n
|
||||
|
||||
- 在进行翻译时，如果你遇到一种你不熟悉的语言，可以使用另一种你已经翻译过的语言，并在 PR 中指出你无法翻译的语言。
|
||||
|
||||
|
||||
@@ -65,7 +65,12 @@
|
||||
|
||||
## 🔧 開發與建置
|
||||
|
||||
### 開發
|
||||
### Chrome or Edge browser
|
||||
|
||||
<details>
|
||||
<summary>Chrome or Edge browser</summary>
|
||||
|
||||
#### 開發 (Chrome or Edge)
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
@@ -74,7 +79,7 @@ pnpm dev
|
||||
然後在瀏覽器中使用 `extension/` 資料夾載入此擴充功能。
|
||||
每次修改後，您需要點選 [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) 按鈕，然後重新整理頁面，以確保更改生效。
|
||||
|
||||
### 建置
|
||||
#### 建置 (Chrome or Edge)
|
||||
|
||||
建置此擴充功能，需要執行以下指令
|
||||
|
||||
@@ -84,15 +89,45 @@ pnpm build
|
||||
|
||||
然後打包 `extension` 下的檔案
|
||||
|
||||
### 🤝 貢獻
|
||||
</details>
|
||||
|
||||
#### 關於分支
|
||||
### Firefox browser
|
||||
|
||||
在那之前，請使用 `dev-firefox` 分支來進行以下操作。它可能包含一些錯誤或不清楚的代碼，歡迎您幫忙解決這些問題！:D
|
||||
|
||||
<details>
|
||||
<summary>Firefox browser</summary>
|
||||
|
||||
#### 開發 (Firefox)
|
||||
|
||||
```bash
|
||||
pnpm dev-firefox
|
||||
```
|
||||
|
||||
然後在瀏覽器中使用 `extension-firefox/` 資料夾載入此擴充功能。
|
||||
每次修改後，您需要點選 [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) 按鈕，然後重新整理頁面，以確保更改生效。
|
||||
|
||||
#### 建置 (Firefox)
|
||||
|
||||
建置此擴充功能，需要執行以下指令
|
||||
|
||||
```bash
|
||||
pnpm build-firefox
|
||||
```
|
||||
|
||||
然後打包 `extension-firefox` 下的檔案
|
||||
|
||||
</details>
|
||||
|
||||
## 🤝 貢獻
|
||||
|
||||
### 關於分支
|
||||
|
||||
- **Main**: 此分支設計用於僅涉及文件檔案（如 README 檔案）的更改，不更改程式碼或其功能。
|
||||
- **Dev**: 使用此分支進行新功能的開發、改進效能或對語系檔（i18n）的修改。
|
||||
- **Bugfixes**: 此分支專門用於修正 main 分支中出現的錯誤。
|
||||
|
||||
#### I18n
|
||||
### I18n
|
||||
|
||||
- 在進行翻譯時，如果你遇到一種你不熟悉的語言，你可以使用另一種你已經翻譯過的語言來翻譯，並在 PR 中指出你無法翻譯的那個語言。
|
||||
- **請手動維護 i18n 國際化語系檔！！！** 請勿使用 `i18n Ally` 或其他擴充套件來進行維護。 我知道你可能會感到困惑，或者可能不喜歡這樣做，但使用 `i18n Ally` 進行維護後，將不確定翻譯放在哪裏，或刪除程式碼註解。
|
||||
|
||||
@@ -65,7 +65,12 @@
|
||||
|
||||
## 🔧 開發同建置
|
||||
|
||||
### 開發
|
||||
### Chrome or Edge browser
|
||||
|
||||
<details>
|
||||
<summary>Chrome or Edge browser</summary>
|
||||
|
||||
#### 開發 (Chrome or Edge)
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
@@ -74,7 +79,7 @@ pnpm dev
|
||||
然之後喺瀏覽器度用 `extension/` 資料夾愛嚟載入此擴充功能。
|
||||
每一次執過 code 之後，你都要撳 [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) 粒掣，然之後 refresh 個 page，確保係有效果。
|
||||
|
||||
### 建置
|
||||
#### 建置 (Chrome or Edge)
|
||||
|
||||
建置擴充功能，要執行下底嘅指令
|
||||
|
||||
@@ -84,15 +89,45 @@ pnpm build
|
||||
|
||||
然之後打包 `extension` 下嘅檔案
|
||||
|
||||
### 🤝 貢獻
|
||||
</details>
|
||||
|
||||
#### 關於分支
|
||||
### Firefox browser
|
||||
|
||||
整之前呢，請用 dev-firefox 分支去做下低嘅操作。佢可能會有啲 bugs 抑或亂晒籠嘅程式碼，歡迎閣下幫手解決呢啲問題！:D
|
||||
|
||||
<details>
|
||||
<summary>Firefox</summary>
|
||||
|
||||
#### 開發 (Firefox)
|
||||
|
||||
```bash
|
||||
pnpm dev-firefox
|
||||
```
|
||||
|
||||
然之後喺瀏覽器度用 `extension-firefox/` 資料夾愛嚟載入此擴充功能。
|
||||
每一次執過 code 之後，你都要撳 [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) 粒掣，然之後 refresh 個 page，確保係有效果。
|
||||
|
||||
#### 建置 (Firefox)
|
||||
|
||||
建置擴充功能，要執行下底嘅指令
|
||||
|
||||
```bash
|
||||
pnpm build-firefox
|
||||
```
|
||||
|
||||
然之後打包 `extension-firefox` 下嘅檔案
|
||||
|
||||
</details>
|
||||
|
||||
## 🤝 貢獻
|
||||
|
||||
### 關於分支
|
||||
|
||||
- **Main**: 呢個分支係專門愛嚟執吓文件檔案（例如如 README 檔案），唔執程式碼抑或佢啲功能。
|
||||
- **Dev**: 用呢個分支進行新功能嘅開發、改進效能抑或執語系檔（i18n）。
|
||||
- **Bugfixes**: 呢個分支專門愛嚟執啲喺 main 分支中出現嘅錯誤。
|
||||
|
||||
#### i18n
|
||||
### i18n
|
||||
|
||||
- 喺翻譯嗰陣，若然你遇到一種你唔熟嘅語言，你可以用第種識翻譯嘅語言來翻譯，兼且喺 PR 講明你唔識譯邊種語言。
|
||||
- **請手動維護 i18n 國際化語系檔！！！** 請勿使用 `i18n Ally` 抑或其他擴充套件維護。 我知你可能唔係幾明，抑或可能唔鍾意咁樣，但係用 `i18n Ally` 進行維護之後，你唔之你翻譯咗嘅內容擺喺邊處，或剷咗程式碼註解。
|
||||
|
||||
61
README.md
61
README.md
@@ -40,7 +40,7 @@ Even in the Edge browser, we strongly recommend you install it in the Chrome web
|
||||
|
||||
> Ensure you installed [extension.zip](https://github.com/hakadao/BewlyBewly/releases) .
|
||||
|
||||
Opening the `edge://extensions` page in the Edge or `chrome://extensions` page in the Chrome, simply drag and drop the downloaded `extension.zip` file into the browser to complete the installation.
|
||||
Opening the `edge://extensions` page in the Edge or `chrome://extensions` page in Chrome, simply drag and drop the downloaded `extension.zip` file into the browser to complete the installation.
|
||||
|
||||
<details>
|
||||
<summary> Another installation method for Edge & Chrome </summary>
|
||||
@@ -59,22 +59,27 @@ Opening the `edge://extensions` page in the Edge or `chrome://extensions` page i
|
||||
|
||||
1. Type in `chrome://extensions/` in the address bar and press Enter
|
||||
2. Turn on `Developer mode` then press `Load unpacked` <br/> <img width="655" alt="Snipaste_2022-03-27_18-17-04" src="https://user-images.githubusercontent.com/33394391/160276882-13da0484-92c1-47dd-add8-7655c5c2bf1c.png">
|
||||
3. Load decompressed exetension folder in your browser
|
||||
3. Load the decompressed extension folder in your browser
|
||||
|
||||
</details>
|
||||
|
||||
## 🔧 Development & build
|
||||
## 🔧 Development & Build
|
||||
|
||||
### Development
|
||||
### Chrome or Edge browser
|
||||
|
||||
<details>
|
||||
<summary>Chrome or Edge browser</summary>
|
||||
|
||||
#### Development (Chrome or Edge)
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
Then **load extension in browser with the `extension/` folder**.
|
||||
After each modification, you need to click the [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) button and refresh the page to ensure the changes would be applied.
|
||||
Then **load the extension in the browser with the `extension/` folder**.
|
||||
After each modification, you need to click the [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) button and refresh the page to ensure the changes will be applied.
|
||||
|
||||
### Build
|
||||
##### Build (Chrome or Edge)
|
||||
|
||||
To build the extension, run
|
||||
|
||||
@@ -82,21 +87,51 @@ To build the extension, run
|
||||
pnpm build
|
||||
```
|
||||
|
||||
And then pack files under `extension`
|
||||
And then pack files under the `extension`
|
||||
|
||||
### 🤝 Contribution
|
||||
</details>
|
||||
|
||||
#### About branches
|
||||
### Firefox browser
|
||||
|
||||
Before that, please use the `dev-firefox` branch to perform the operations below. It may contain some bugs or unclear code, and your help in addressing these issues is welcome! :D
|
||||
|
||||
<details>
|
||||
<summary>Firefox browser</summary>
|
||||
|
||||
#### Development (Firefox)
|
||||
|
||||
```bash
|
||||
pnpm dev-firefox
|
||||
```
|
||||
|
||||
Then **load the extension in the browser with the `extension-firefox/` folder**.
|
||||
After each modification, you need to click the [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) button and refresh the page to ensure the changes will be applied.
|
||||
|
||||
#### Build (Firefox)
|
||||
|
||||
To build the extension, run
|
||||
|
||||
```bash
|
||||
pnpm build-firefox
|
||||
```
|
||||
|
||||
And then pack files under the `extension-firefox`
|
||||
|
||||
</details>
|
||||
|
||||
## 🤝 Contribution
|
||||
|
||||
### About Branches
|
||||
|
||||
- **Main**: This branch is designed for changes that are restricted to documentation files like READMEs, without altering the code or its functionality.
|
||||
- **Dev**: Use this brach for new features, performance improvements or modifications to i18n files.
|
||||
- **Dev**: Use this branch for new features, performance improvements or modifications to i18n files.
|
||||
- **Bugfixes**: This branch should be used exclusively for fixing bugs that appear in the main branch.
|
||||
|
||||
#### I18n
|
||||
### I18n
|
||||
|
||||
- When doing translations, if you have a language you are not familiar with, you can use another language that you have translated and point out what language you cannot translate in the pull request.
|
||||
|
||||
- **Please MANUALLY MAINTAIN the i18n files!!!** Do not use `i18n Ally` or other extensions to maintain them. I know you might be confused or might not like this, but using `i18n Ally` for the maintenance will be uncertain where to place the translations afterward or delete the code comments.
|
||||
- **Please MANUALLY MAINTAIN the i18n files!!!** Do not use `i18n Ally` or other extensions to maintain them. I know you might be confused or might not like this, but using `i18n Ally` for the maintenance will make it uncertain where to place the translations afterward or delete the code comments.
|
||||
|
||||
## ❤️ Credits
|
||||
|
||||
|
||||
Reference in New Issue
Block a user