From 7660dad4eb6ee0cf12cbeb4c79ce200f2fc24a80 Mon Sep 17 00:00:00 2001 From: veeso Date: Sat, 25 Sep 2021 13:56:40 +0200 Subject: [PATCH] man-en --- README.md | 13 +++++++++++-- docs/{man.md => man-en.md} | 0 2 files changed, 11 insertions(+), 2 deletions(-) rename docs/{man.md => man-en.md} (100%) diff --git a/README.md b/README.md index 05b930c..1e46abf 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ These requirements are not forcely required to run termscp, but to enjoy all of - *gnome-open* - *kde-open* - **Linux** users: - - A keyring manager: read more in the [User manual](docs/man.md#linux-keyring) + - A keyring manager: read more in the [User manual](docs/man_en.md#linux-keyring) - **WSL** users - To **open** files via `V` (at least one of these) - [wslu](https://github.com/wslutilities/wslu) @@ -108,7 +108,14 @@ If you like termscp and you'd love to see the project to grow, please consider a --- -## Documentation 📚 +## 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: + +- ![en](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/United-Kingdom.png) [User manual (English)](docs/man-en.md) +- ![zh](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/China.png) [į”¨æˆˇæ‰‹å†Œ (įŽ€äŊ“中文)](docs/man-zh.md) + +A translation of the user manual in other languages would be really appreciated 😉 The developer documentation can be found on Rust Docs at @@ -144,6 +151,8 @@ Along to new features, termscp developments is now focused on UX and performance Contributions, bug reports, new features and questions are welcome! 😉 If you have any question or concern, or you want to suggest a new feature, or you want just want to improve termscp, feel free to open an issue or a PR. +An **appreciated** contribution would be a translation of the user manual and readme in **other languages** + Please follow [our contributing guidelines](CONTRIBUTING.md) --- diff --git a/docs/man.md b/docs/man-en.md similarity index 100% rename from docs/man.md rename to docs/man-en.md