[docs] Update contributing and translation instructions

ProjectBlackPearl · Apr 21, 2023 · 0e99e5b · 0e99e5b
1 parent b1b8bab
commit 0e99e5b
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 56 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,38 +16,6 @@ You will need [git](https://git-scm.com) for contributing.
 4. Push them to Github `git push -u origin branchname`
 5. Open a PR
 
-## **Translating**
-
----
-
-PBP supports other languages, which means you can use it without knowing English. Any translation is greatly appreciated.<br>
-
-There are two ways of doing it:<br>
-
-<details>
-    <summary>Using POEditor</summary>
-
-1. Create an account on [POEditor](https://poeditor.com)
-2. Join [our project](https://poeditor.com/join/project/G4mEFhRCt0) on it
-3. Search for your language you want to translate
-4. Start translating!
- </details>
-
-<details>
-    <summary>Using Github</summary>
-
-1. [Fork the repo](https://github.com/ProjectBlackPearl/PBPL/fork)
-2. Create a branch `git checkout -b klingon-translation`
-3. Go to `src/locale/lang`
-4. Create a new file named after the [2-letter ISO code (ISO-639-1)](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
-5. Copy the `en.json` file into it
-6. Edit the file but not the keys (Example: `loadingText`)
-7. Throw everything into your fork
-8. Open a PR
-
-</details>
-<br>
-
 ## **Style guidelines**
 
 ---

diff --git a/LOCALIZATION.md b/LOCALIZATION.md
@@ -0,0 +1,60 @@
+# Localization
+
+Project Black Pearl has full localization support and any number of languages can be added and changed natively.
+
+### Guidelines/Tips for adding Translations:
+
+-   Only add translations for things that you are 100% sure on. Partially translating files is ok as long as you put in some effort.
+-   If you are unsure about a translation, leave it blank. It is better to have a blank translation than a wrong one.
+
+## How to translate:
+
+There are two ways of doing it:<br>
+
+-   ### Using POEditor
+<details>
+
+1. Create an account on [POEditor](https://poeditor.com)
+2. Join [our project](https://poeditor.com/join/project/G4mEFhRCt0) on it
+3. Search for your language you want to translate
+4. Start translating!
+ </details>
+
+-   ### Using Github
+<details>
+
+1. [Fork the repo](https://github.com/ProjectBlackPearl/PBPL/fork)
+2. Create a branch `git checkout -b klingon-translation`
+3. Go to `src/locale/lang`
+4. Create a new file named after the [2-letter ISO code (ISO-639-1)](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
+5. Copy the `en.json` file into it
+6. Edit the file but not the keys (Example: `loadingText`)
+7. Push the changes into your fork adhering to [CONTRIBUTING.md](./CONTRIBUTING.md)
+8. Open a PR.
+
+</details>
+<br>
+
+## Credits:
+
+    ohvii: Swedish translation
+    despair: French translation
+    plaga: Hungarian translation
+    superweird7: Arabic translation
+    GooUckd: Estonian and Finnish translation
+    Q99: Bosnian and Serbian translation
+    Mirza Čustović: Croatian translation
+    N3kowarrior: Czech translation
+    Rafo: Dutch translation
+    Brisolo32: Portuguese (Brazil) and Esperanto translation
+    zun1: German translation
+    xDal-Lio: Italian translation
+    Lol123zv: Latvian and Russian translation
+    SteinScanner and Mr Mango:	Polish translation
+    Sup3r: Portuguese (Portugal) translation
+    AlexanderMaxRanabel: Turkish translation
+    SoulStyle: Romanian translation
+    TeeNam:	Vietnamese translation (To be finished)
+    lyubomir501: Bulgarian translation
+
+    Terrence Tingleberry: Proofreading those translations
diff --git a/README.md b/README.md
@@ -10,39 +10,20 @@ Unify your game sources in one place by using modules made by the community.
 
 ## What is Project Black Pearl?
 
-**Project Black Pearl** (or PBP) is a [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) project that aims to unify game sources in one place by utilizing  extensions made by the community. It is aimed to provide a convenient way of dealing with games sourced from all sorts of websites and provides a store system powered by a powerful extension ecosystem.
+**Project Black Pearl** (or PBP) is a [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) project that aims to unify game sources in one place by utilizing extensions made by the community. It is aimed to provide a convenient way of dealing with games sourced from all sorts of websites and provides a store system powered by a powerful extension ecosystem.
 
 ## What is the current state of the project?
 
 PBP is currently in early Beta stages and its overall functionality is very limited. You can check [the to-do list](https://github.com/orgs/ProjectBlackPearl/projects/3) to see what features are planned or currently in development.
 
 ## How can I contribute?
 
-### Recommended IDE Setup
+We welcome any contributions to the project, be it code, translations, or just general feedback. You can check out the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information on how to contribute.
+Please remember that translations are managed differently than code contributions as mentioned below.
 
-[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode).
+## Translations:
 
--   ### Clone the repository
-
-```bash
-git clone https://github.com/ProjectBlackPearl/pbpl.git
-cd pbpl
-```
-
--   ### Install the dependencies
-
-```bash
- npm install
-```
-
--   ### Make your changes
--   ### Run the project
-
-```bash
-npm run tauri dev
-```
-
--   ### Create a Pull Request!
+Project Black Pearl supports full localization. Instructions to help translate the project can be found in [LOCALIZATION.md](./LOCALIZATION.md).
 
 ## Wiki