Merge branch 'md-translations' into 0.7.0

.github/ISSUE_TEMPLATE/copy.md

@@ -0,0 +1,35 @@
+---
+name: Copy
+about: Report a typo/error in a repository document
+title: "[COPY] - ISSUE_TITLE"
+labels: documentation
+assignees: veeso
+
+---
+
+## Report
+
+### DOCUMENT NAME
+
+This sentence at row ROW_NUMBER doesn't seem right:
+
+> Write down here the wrong sentence
+
+and I think it should be changed to:
+
+> Write down here the correct sentence
+
+`Copy paste the template above for all the sentences to fix`
+
+---
+
+`Copy paste the template above for all the documents to fix`
+
+## Additional information
+
+> ❗ Report LANGUAGE checks only if it concerns the documents above
+> ❗ If the documents concerns more than one language, copy paste the checks below for each check you want to report
+> ❗ The PR mention regards the indicated language. If you check the box, I may add you to a PR where I need to translate a new section of the user manual/README or other documents. I promise I won't stress you anyway.
+
+- [ ] I am C1/C2 speaker for this language: LANGUAGE
+  - [ ] You can mention me in a PR in case a review for translations is needed

CONTRIBUTING.md

@@ -9,6 +9,7 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
   - [Open an issue](#open-an-issue)
     - [Questions](#questions)
     - [Bug reports](#bug-reports)
+    - [Copy error](#copy-error)
     - [Feature requests](#feature-requests)
   - [Preferred contributions](#preferred-contributions)
   - [Pull Request Process](#pull-request-process)
@@ -45,6 +46,7 @@ Open an issue when:
 
 - You have questions or concerns regarding the project or the application itself.
 - You have a bug to report.
+- You have a copy error to report. (Error in documentation; bad translation or sentence)
 - You have a feature or a suggestion to improve termscp to submit.
 
 ### Questions
@@ -71,6 +73,15 @@ Maintainers will may add additional labels to your issue:
 - **sorcery**: it is not possible to find out what's causing your bug, nor is reproducible on our test environments.
 - **wontfix**: your bug has a very high ratio between the difficulty to fix it and the probability to encounter it, or it just isn't a bug, but a feature.
 
+### Copy error
+
+If you want to report a copy error, create an issue using the `copy` template.
+The `Documentation` label should already be set and the issue should already be assigned to `veeso`.
+
+If you want to fix the copy by yourself you can fork the project and open a PR, otherwise I will fix it by myself.
+The copy issue is accepted **also if you're not a C1/C2 speaker**, but a speaker of that level in case the language is different from Italian/English is preferred.
+Please fullfil the form on the bottom of the template if you want.
+
 ### Feature requests
 
 Whenever you have a good idea which chould improve the project, it is a good idea to submit it to the project owner.
@@ -97,9 +108,10 @@ Always mind that your suggestion, may be rejected: I'll always provide a feedbac
 At the moment, these kind of contributions are more appreciated and should be preferred:
 
 - Fix for issues described in [Known Issues](./README.md#known-issues-) or [issues reported by the community](https://github.com/veeso/termscp/issues)
-- New file transfers: for further details see [Implementing File Transfer](#implementing-file-transfers)
-- Code optimizations: any optimization to the code is welcome
+- **New file transfers**: for further details see [Implementing File Transfer](#implementing-file-transfers). ⚠️ this is going to be deprecated SOON! We're moving the file transfers into another library. Please see [remotefs-rs](https://github.com/veeso/remotefs-rs).
+- **Code optimizations**: any optimization to the code is welcome
 - See also features described in [Upcoming features](./README.md##upcoming-features-). Open an issue first though.
+- README/User manual **translations**: really appreciated atm. Please just add a folder into `docs/` with the language code. Language code with two characters is used in case the language is understandable by all the countries where this language is spoken (e.g. `it-CH`, `it-IT` are not really different, so I just created `it`, but there is a big difference from `zh-CN` and `zh-TW` for instance). Don't worry about flags in README, I will implement that part if it's too complicated.
 
 For any other kind of contribution, especially for new features, please submit a new issue first.
 

README.md

@@ -13,18 +13,118 @@
   <a href="https://veeso.github.io/termscp/#user-manual" target="_blank">User manual</a>
 </p>
 
-<p align="center">Developed by <a href="https://veeso.github.io/">@veeso</a></p>
-<p align="center">Current version: 0.7.0 (12/10/2021)</p>
+<p align="center">
+  <a href="https://github.com/veeso/termscp"
+    ><img
+      height="20"
+      src="/assets/images/flags/us.png"
+      alt="English"
+  /></a>
+  &nbsp;
+  <a
+    href="/docs/de/README.md"
+    ><img
+      height="20"
+      src="/assets/images/flags/de.png"
+      alt="Deutsch"
+  /></a>
+  &nbsp;
+  <a
+    href="/docs/es/README.md"
+    ><img
+      height="20"
+      src="/assets/images/flags/es.png"
+      alt="Español"
+  /></a>
+  &nbsp;
+  <a
+    href="/docs/fr/README.md"
+    ><img
+      height="20"
+      src="/assets/images/flags/fr.png"
+      alt="Français"
+  /></a>
+  &nbsp;
+  <a
+    href="/docs/it/README.md"
+    ><img
+      height="20"
+      src="/assets/images/flags/it.png"
+      alt="Italiano"
+  /></a>
+  &nbsp;
+  <a
+    href="/docs/zh-CN/README.md"
+    ><img
+      height="20"
+      src="/assets/images/flags/cn.png"
+      alt="简体中文"
+  /></a>
+</p>
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-teal.svg)](https://opensource.org/licenses/MIT) [![Stars](https://img.shields.io/github/stars/veeso/termscp.svg)](https://github.com/veeso/termscp) [![Downloads](https://img.shields.io/crates/d/termscp.svg)](https://crates.io/crates/termscp) [![Crates.io](https://img.shields.io/badge/crates.io-v0.7.0-orange.svg)](https://crates.io/crates/termscp)  
+<p align="center">Developed by <a href="https://veeso.github.io/" target="_blank">@veeso</a></p>
+<p align="center">Current version: 0.7.0 (12/10/2021)</p>
 
-[![Linux](https://github.com/veeso/termscp/workflows/Linux/badge.svg)](https://github.com/veeso/termscp/actions) [![MacOs](https://github.com/veeso/termscp/workflows/MacOS/badge.svg)](https://github.com/veeso/termscp/actions) [![Windows](https://github.com/veeso/termscp/workflows/Windows/badge.svg)](https://github.com/veeso/termscp/actions) [![FreeBSD](https://github.com/veeso/termscp/workflows/FreeBSD/badge.svg)](https://github.com/veeso/termscp/actions) [![Coverage Status](https://coveralls.io/repos/github/veeso/termscp/badge.svg)](https://coveralls.io/github/veeso/termscp) [![Docs](https://docs.rs/termscp/badge.svg)](https://docs.rs/termscp)
+<p align="center">
+  <a href="https://opensource.org/licenses/MIT"
+    ><img
+      src="https://img.shields.io/badge/License-MIT-teal.svg"
+      alt="License-MIT"
+  /></a>
+  <a href="https://github.com/veeso/termscp/stargazers"
+    ><img
+      src="https://img.shields.io/github/stars/veeso/termscp.svg"
+      alt="Repo stars"
+  /></a>
+  <a href="https://crates.io/crates/termscp"
+    ><img
+      src="https://img.shields.io/crates/d/termscp.svg"
+      alt="Downloads counter"
+  /></a>
+  <a href="https://crates.io/crates/termscp"
+    ><img
+      src="https://img.shields.io/crates/v/termscp.svg"
+      alt="Latest version"
+  /></a>
+</p>
+<p align="center">
+  <a href="https://github.com/veeso/termscp/actions"
+    ><img
+      src="https://github.com/veeso/termscp/workflows/Linux/badge.svg"
+      alt="Linux CI"
+  /></a>
+  <a href="https://github.com/veeso/termscp/actions"
+    ><img
+      src="https://github.com/veeso/termscp/workflows/MacOS/badge.svg"
+      alt="MacOS CI"
+  /></a>
+  <a href="https://github.com/veeso/termscp/actions"
+    ><img
+      src="https://github.com/veeso/termscp/workflows/Windows/badge.svg"
+      alt="Windows CI"
+  /></a>
+  <a href="https://github.com/veeso/termscp/actions"
+    ><img
+      src="https://github.com/veeso/termscp/workflows/FreeBSD/badge.svg"
+      alt="FreeBSD CI"
+  /></a>
+  <a href="https://coveralls.io/github/veeso/termscp"
+    ><img
+      src="https://coveralls.io/repos/github/veeso/termscp/badge.svg"
+      alt="Coveralls"
+  /></a>
+  <a href="https://docs.rs/termscp"
+    ><img
+      src="https://docs.rs/termscp/badge.svg"
+      alt="Docs"
+  /></a>
+</p>
 
 ---
 
 ## About termscp 🖥
 
-Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP/S3. So basically is a terminal utility with an TUI to connect to a remote server to retrieve and upload files and to interact with the local file system. It is **Linux**, **MacOS**, **FreeBSD** and **Windows** compatible and supports SFTP, SCP, FTP, FTPS and S3.
+Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP/S3. So basically is a terminal utility with an TUI to connect to a remote server to retrieve and upload files and to interact with the local file system. It is **Linux**, **MacOS**, **FreeBSD** and **Windows** compatible.
 
 ![Explorer](assets/images/explorer.gif)
 
@@ -60,7 +160,7 @@ Termscp is a feature rich terminal file transfer and explorer, with support for
 ## Get started 🚀
 
 If you're considering to install termscp I want to thank you 💜 ! I hope you will enjoy termscp!  
-If you want to contribute to this project, don't forget to check out our contribute guide. [Read More](CONTRIBUTING.md)
+If you want to contribute to this project, don't forget to check out our [contribute guide](CONTRIBUTING.md).
 
 If you are a Linux, a FreeBSD or a MacOS user this simple shell script will install termscp on your system with a single command:
 
@@ -84,45 +184,40 @@ For more information or other platforms, please visit [veeso.github.io](https://
   - libssh
   - libdbus-1
   - pkg-config
-- **BSD** users:
+- **FreeBSD** users:
   - libssh
   - dbus
   - pkgconf
 
 ### Optional Requirements ✔️
 
-These requirements are not forcely required to run termscp, but to enjoy all of its features
+These requirements are not forced required to run termscp, but to enjoy all of its features
 
-- **Linux/BSD** users:
+- **Linux/FreeBSD** users:
   - To **open** files via `V` (at least one of these)
     - *xdg-open*
     - *gio*
     - *gnome-open*
     - *kde-open*
 - **Linux** users:
-  - A keyring manager: read more in the [User manual](docs/man_en.md#linux-keyring)
+  - A keyring manager: read more in the [User manual](docs/man.md#linux-keyring)
 - **WSL** users
   - To **open** files via `V` (at least one of these)
     - [wslu](https://github.com/wslutilities/wslu)
 
 ---
 
-## Buy me a coffee ☕
+## Support me ☕
 
-If you like termscp and you'd love to see the project to grow, please consider a little donation 🥳
+If you like termscp and you'd love to see the project to grow and to improve, please consider a little donation to support me on **Buy me a coffee** 🥳
 
 [![Buy-me-a-coffee](https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=&slug=veeso&button_colour=404040&font_colour=ffffff&font_family=Comic&outline_colour=ffffff&coffee_colour=FFDD00)](https://www.buymeacoffee.com/veeso)
 
 ---
 
 ## User manual and Documentation 📚
 
-The user manual can be found on the [termscp's website](https://veeso.github.io/termscp/#user-manual) or on Github:
-
-- [User manual](docs/man-en.md)
-- [用户手册](docs/man-zh.md)
-
-A translation of the user manual in other languages would be really appreciated 😉
+The user manual can be found on the [termscp's website](https://veeso.github.io/termscp/#user-manual) or on [Github](docs/man.md).
 
 The developer documentation can be found on Rust Docs at <https://docs.rs/termscp>
 
@@ -177,7 +272,7 @@ View termscp's changelog [HERE](CHANGELOG.md)
 
 ## Powered by 💪
 
-termscp is powered by these aweseome projects:
+termscp is powered by these awesome projects:
 
 - [bytesize](https://github.com/hyunsik/bytesize)
 - [crossterm](https://github.com/crossterm-rs/crossterm)