wip

2025-12-07 09:36:00 -08:00 · 2021-10-06 08:45:02 +02:00
parent 6421b74c66
commit e09682c219
6 changed files with 731 additions and 5 deletions
--- a/docs/de/README.md
+++ b/docs/de/README.md
@@ -0,0 +1,242 @@
+# termscp
+
+<p align="center">
+  <img src="/assets/images/termscp.svg" width="256" height="256" />
+</p>
+
+<p align="center">~ A feature rich terminal file transfer ~</p>
+<p align="center">
+  <a href="https://veeso.github.io/termscp/" target="_blank">Website</a>
+  ·
+  <a href="https://veeso.github.io/termscp/#get-started" target="_blank">Installation</a>
+  ·
+  <a href="https://veeso.github.io/termscp/#user-manual" target="_blank">User manual</a>
+</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>
+
+<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>
+
+[![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)  
+
+[![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)
+
+---
+
+## 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.
+
+![Explorer](/assets/images/explorer.gif)
+
+---
+
+## Features 🎁
+
+- 📁  Different communication protocols
+  - **SFTP**
+  - **SCP**
+  - **FTP** and **FTPS**
+  - **Aws S3**
+- 🖥  Explore and operate on the remote and on the local machine file system with a handy UI
+  - Create, remove, rename, search, view and edit files
+- ⭐  Connect to your favourite hosts through built-in bookmarks and recent connections
+- 📝  View and edit files with your favourite applications
+- 💁  SFTP/SCP authentication with SSH keys and username/password
+- 🐧  Compatible with Windows, Linux, FreeBSD and MacOS
+- 🎨  Make it yours!
+  - Themes
+  - Custom file explorer format
+  - Customizable text editor
+  - Customizable file sorting
+  - and many other parameters...
+- 📫  Get notified via Desktop Notifications when a large file has been transferred
+- 🔐  Save your password in your operating system key vault
+- 🦀  Rust-powered
+- 👀  Developed keeping an eye on performance
+- 🦄  Frequent awesome updates
+
+---
+
+## 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](../../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:
+
+```sh
+curl --proto '=https' --tlsv1.2 -sSLf "https://git.io/JBhDb" | sh
+```
+
+while if you're a Windows user, you can install termscp with [Chocolatey](https://chocolatey.org/):
+
+```sh
+choco install termscp
+```
+
+For more information or other platforms, please visit [veeso.github.io](https://veeso.github.io/termscp/#get-started) to view all installation methods.
+
+⚠️ If you're looking on how to update termscp just run termscp from CLI with: `(sudo) termscp --update` ⚠️
+
+### Requirements ❗
+
+- **Linux** users:
+  - libssh
+  - libdbus-1
+  - pkg-config
+- **FreeBSD** users:
+  - libssh
+  - dbus
+  - pkgconf
+
+### Optional Requirements ✔️
+
+These requirements are not forced required to run termscp, but to enjoy all of its features
+
+- **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](man.md#linux-keyring)
+- **WSL** users
+  - To **open** files via `V` (at least one of these)
+    - [wslu](https://github.com/wslutilities/wslu)
+
+---
+
+## Support me ☕
+
+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](man.md).
+
+The developer documentation can be found on Rust Docs at <https://docs.rs/termscp>
+
+---
+
+## Known issues 🧻
+
+- `NoSuchFileOrDirectory` on connect (WSL1): I know about this issue and it's a glitch of WSL I guess. Don't worry about it, just move the termscp executable into another PATH location, such as `/usr/bin`, or install it through the appropriate package format (e.g. deb).
+
+---
+
+## Contributing and issues 🤝🏻
+
+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.
+
+Please follow [our contributing guidelines](../../CONTRIBUTING.md)
+
+---
+
+## Changelog ⏳
+
+View termscp's changelog [HERE](../../CHANGELOG.md)
+
+---
+
+## Powered by 💪
+
+termscp is powered by these awesome projects:
+
+- [bytesize](https://github.com/hyunsik/bytesize)
+- [crossterm](https://github.com/crossterm-rs/crossterm)
+- [edit](https://github.com/milkey-mouse/edit)
+- [keyring-rs](https://github.com/hwchen/keyring-rs)
+- [open-rs](https://github.com/Byron/open-rs)
+- [rpassword](https://github.com/conradkleinespel/rpassword)
+- [rust-s3](https://github.com/durch/rust-s3)
+- [self_update](https://github.com/jaemk/self_update)
+- [ssh2-rs](https://github.com/alexcrichton/ssh2-rs)
+- [suppaftp](https://github.com/veeso/suppaftp)
+- [textwrap](https://github.com/mgeisler/textwrap)
+- [tui-rs](https://github.com/fdehau/tui-rs)
+- [tui-realm](https://github.com/veeso/tui-realm)
+- [whoami](https://github.com/libcala/whoami)
+- [wildmatch](https://github.com/becheran/wildmatch)
+
+---
+
+## Gallery 🎬
+
+> Termscp Home
+
+![Auth](/assets/images/auth.gif)
+
+> Bookmarks
+
+![Bookmarks](/assets/images/bookmarks.gif)
+
+> Setup
+
+![Setup](/assets/images/config.gif)
+
+> Text editor
+
+![TextEditor](/assets/images/text-editor.gif)
+
+---
+
+## License 📃
+
+termscp is licensed under the MIT license.
+
+You can read the entire license [HERE](../../LICENSE)