mirror of
https://github.com/VueTubeApp/VueTube
synced 2024-11-25 12:45:17 +00:00
Documentation changes (#546)
* Add files via upload * Update readme.es.md * Update readme.md * Update readme.md * Update readme.md * Create readme.md * Add files via upload * Add files via upload * Update readme.md * Update readme.md
This commit is contained in:
parent
d9a49db4ac
commit
353aa0ac63
7 changed files with 86 additions and 6 deletions
|
@ -1,4 +1,6 @@
|
|||
# App translations guide
|
||||
# Guide for translating the app
|
||||
|
||||
If you want to translate the documentation instead, check the [guide for translating the documentation](/readme/readme.md).
|
||||
|
||||
## ⛔️ Rules and advices
|
||||
|
||||
|
@ -6,7 +8,7 @@
|
|||
|
||||
Translations made automatically are not allowed in VueTube. You need to know and understand both English and the language you're translating to guarantee a good result. Please do not contribute using Google Translator or similars.
|
||||
|
||||
_Example: "Enable Return Youtube Dislike integration" should be translated to Spanish as "Activar la integración de Return YouTube Dislike", but an automatic translation could be "Activar integración Devolver los No me gusta de Youtube", and that doesn't sounds natural._
|
||||
_Example: "Enable Return Youtube Dislike integration" should be translated to Spanish as "Activar la integración de Return YouTube Dislike", but an automatic translation could be "Activar integración Devolver los No me gusta de Youtube", and that doesn't sound natural._
|
||||
|
||||
- **Consider leaving some words in English**
|
||||
|
||||
|
@ -47,3 +49,8 @@ You can’t add a file directly to VueTube repository, but you can do a fork. Th
|
|||
After you have done everything, go to Pull Requests on VueTube repository and make a new one clicking in “Compare across repositories”. Include a description about what have you changed. A VueTube admin will approve your changes and your translation will be implemented.
|
||||
|
||||
<p align="center"> Thank you for being interested on contributing! </p>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
**Note:** We rely on your good faith. As a community project, many of our maintainers are not native speakers of the languages that the community has provided. We will do our best to review your translations, but we are heavily dependent on the community to provide us with quality translations. In cases where disagreements arise between translators, we may be forced to mediate and make a decision regardless of our team's proficiency in the language. As such, we ask that disagreements between translators be solved in a civil manner without the need for moderation.
|
||||
|
|
22
readme.md
22
readme.md
|
@ -64,18 +64,34 @@ To install the app, please visit [vuetube.app/install](https://www.vuetube.app/i
|
|||
<summary>🖱️ Click to display versions </summary>
|
||||
<br />
|
||||
|
||||
### Android
|
||||
<h3 align="left">
|
||||
<sub>
|
||||
<img src="resources/readme_icon_android.png"
|
||||
height="20"
|
||||
width="20">
|
||||
</sub>
|
||||
Android
|
||||
</h3>
|
||||
|
||||
| <a href=https://nightly.link/VueTubeApp/VueTube/workflows/ci/main/android.zip><img id="im" width="200" src=./resources/getunstable.png></a> | <a href=https://github.com/VueTubeApp/VueTube/releases/tag/0.4.2><img id="im" width="200" src=./resources/getcanary.png></a> | <a href=https://vuetube.app/install><img id="im" width="200" src=./resources/getstable.png></a> |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| Pretty unstable, but you get early access to new features. | Less bugs than unstable while having more features than stable. | Not available yet. |
|
||||
|
||||
### iOS
|
||||
<h3 align="left">
|
||||
<sub>
|
||||
<img src="resources/readme_icon_ios.png"
|
||||
height="20"
|
||||
width="20">
|
||||
</sub>
|
||||
iOS
|
||||
</h3>
|
||||
|
||||
| <a href=https://nightly.link/VueTubeApp/VueTube/workflows/ci/main/iOS.zip><img id="im" width="200" src=./resources/getunstable.png></a> | <a href=https://cdn.discordapp.com/attachments/949908267855921163/972164558930198528/VueTube-Canary-May-6-2022.ipa><img id="im" width="200" src=./resources/getcanary.png></a> | <a href=https://vuetube.app/install><img id="im" width="200" src=./resources/getstable.png></a> |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
|
||||
| Pretty unstable, but you get early access to new features. | Less bugs than unstable while having more features than stable. | Not available yet. |
|
||||
|
||||
(Apple does not officially support sideloading, i.e. the installation of applications with just the file without them being uploaded to the company's official shop. It is necessary to use advanced methods to install VueTube on iPhone / iPad devices)
|
||||
|
||||
</details>
|
||||
|
||||
<h2 align="left">
|
||||
|
@ -187,7 +203,7 @@ VueTube was made with the aim of providing to the Internet a free, open source a
|
|||
|
||||
Thank you for being interested on contributing! Please read our website on how to do so: [vuetube.app/contributing](https://www.vuetube.app/contributing).
|
||||
|
||||
If you want to translate the app, [click here](/NUXT/plugins/languages) and read the instructions. If GitHub is hard or uncomfortable to you, you can also send the fields translated in a text file on our [Discord](https://vuetube.app/discord) and we will implement them. Don't worry!
|
||||
If you want to translate the app, [click here](/NUXT/plugins/languages/readme.md) and read the instructions. If GitHub is hard or uncomfortable to you, you can also send the fields translated in a text file on our [Discord](https://vuetube.app/discord) and we will implement them. Don't worry!
|
||||
|
||||
<h2 align="left">
|
||||
<sub>
|
||||
|
|
|
@ -276,5 +276,5 @@ Otros repositorios de VueTube
|
|||
<hr>
|
||||
|
||||
<p align="center">
|
||||
<sub>VueTube, haciendo a la gente feliz e iluminando sus corazones desde 2022.</sub>
|
||||
<img src="/resources/readme-es/bottom_banner_readme.png" width="800">
|
||||
</p>
|
||||
|
|
57
readme/readme.md
Normal file
57
readme/readme.md
Normal file
|
@ -0,0 +1,57 @@
|
|||
# Guide for translating the documentation
|
||||
|
||||
If you want to translate the app instead, check the [guide for translating the app](/NUXT/plugins/languages/readme.md).
|
||||
|
||||
## ⛔️ Rules and advices
|
||||
|
||||
- **Please do not use Internet translators**
|
||||
|
||||
Translations made automatically are not allowed in VueTube. You need to know and understand both English and the language you're translating to guarantee a good result. Please do not contribute using Google Translator or similars.
|
||||
|
||||
_Example: "Return Youtube Dislike is integrated in VueTube" should be translated to Spanish as "Return YouTube Dislike está integrado en VueTube", but an automatic translation could be "Devolver los No me gusta de YouTube está de conjunto en VueTube", and that doesn't sound natural._
|
||||
|
||||
- **Consider leaving some words in English**
|
||||
|
||||
Some words might sound better in English. For example, depending of the grade of English casual words in your language, you can consider not translating "Plugins", "Dislike", etc.
|
||||
|
||||
_Example: Instead of translating "Shorts UI" to French as "Interface courts", you can use "Interface Shorts"._
|
||||
|
||||
## 🟢 How to do the translation
|
||||
|
||||
We ask you to first familiarize yourself with the Markdown syntax (opens new window) before translating README files.
|
||||
|
||||
There are two ways to translate README files: using the GitHub web interface or using a text editor. If you are not familiar with Git, we recommend using the GitHub web interface.
|
||||
|
||||
- **Using the GitHub web interface**
|
||||
|
||||
To translate a README file using the GitHub web interface, follow these steps:
|
||||
|
||||
Go to the repository of the README file you want to translate. <br>
|
||||
Press the "Fork" button in the top right corner of the page. <br>
|
||||
Press the "Add file" button in the top right corner of the page. <br>
|
||||
Press the "Create new file" button. <br>
|
||||
Type the name of the README file you want to translate in the "Name your file..." field. For example, if you want to translate the README file in the docs directory, type docs/README-YOUR-LANGUAGE-HERE.md where YOUR-LANGUAGE-HERE is the ISO 639-1 (opens new window)code of the language you are translating to. <br>
|
||||
Copy the contents of the README file you want to translate from the original repository and paste it into the "Edit new file" field. <br>
|
||||
Translate the contents of the README file. <br>
|
||||
Update links to other README files in the translated README file to include the new translation. <br>
|
||||
Save and submit the changes upstream by pressing the "Propose new file" button and then the "Create pull request" button. <br>
|
||||
|
||||
- **Using a text editor**
|
||||
|
||||
The use of a text editor is recommended for more advanced users. We recommend using Visual Studio Code (opens new window). This method assumes you have Git installed and configured on your computer.
|
||||
|
||||
To translate a README file using a text editor, follow these steps:
|
||||
|
||||
Fork the repository of the README file you want to translate. <br>
|
||||
Clone the repository to your computer. <br>
|
||||
Type the name of the README file you want to translate in the "Name your file..." field. For example, if you want to translate the README file in the docs directory, type docs/README-YOUR-LANGUAGE-HERE.md where YOUR-LANGUAGE-HERE is the ISO 639-1 (opens new window)code of the language you are translating to. <br>
|
||||
Copy the contents of the README file you want to translate from the original repository and paste it into the "Edit new file" field. <br>
|
||||
Translate the contents of the README file. <br>
|
||||
Commit and push the changes to your fork, then submit a pull request upstream. <br>
|
||||
|
||||
<p align="center"> Thank you for being interested on contributing! </p>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
**Note:** We rely on your good faith. As a community project, many of our maintainers are not native speakers of the languages that the community has provided. We will do our best to review your translations, but we are heavily dependent on the community to provide us with quality translations. In cases where disagreements arise between translators, we may be forced to mediate and make a decision regardless of our team's proficiency in the language. As such, we ask that disagreements between translators be solved in a civil manner without the need for moderation.
|
BIN
resources/readme-es/bottom_banner_readme.png
Normal file
BIN
resources/readme-es/bottom_banner_readme.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 595 KiB |
BIN
resources/readme_icon_android.png
Normal file
BIN
resources/readme_icon_android.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 2 KiB |
BIN
resources/readme_icon_ios.png
Normal file
BIN
resources/readme_icon_ios.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.8 KiB |
Loading…
Reference in a new issue