From 9f478227a94f543b01d88c634cb2a9f6831ca566 Mon Sep 17 00:00:00 2001 From: ChristianVisintin Date: Mon, 21 Dec 2020 12:02:45 +0100 Subject: [PATCH] 0.2.0 readme --- .github/workflows/aur-pub.yml | 2 +- README.md | 79 ++++++++++++++++++++--------------- 2 files changed, 47 insertions(+), 34 deletions(-) diff --git a/.github/workflows/aur-pub.yml b/.github/workflows/aur-pub.yml index 8d23c27..074f923 100644 --- a/.github/workflows/aur-pub.yml +++ b/.github/workflows/aur-pub.yml @@ -11,7 +11,7 @@ jobs: - name: Publish AUR package uses: KSXGitHub/github-actions-deploy-aur@2.2.3 with: - pkgname: my-awesome-package + pkgname: termscp pkgbuild: ./dist/pkgs/arch/PKGBUILD commit_username: ${{ secrets.AUR_USERNAME }} commit_email: ${{ secrets.AUR_EMAIL }} diff --git a/README.md b/README.md index cc474f3..133f4d6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # TermSCP -[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Stars](https://img.shields.io/github/stars/ChristianVisintin/TermSCP.svg)](https://github.com/ChristianVisintin/TermSCP) [![Issues](https://img.shields.io/github/issues/ChristianVisintin/TermSCP.svg)](https://github.com/ChristianVisintin/TermSCP/issues) [![Downloads](https://img.shields.io/crates/d/termscp.svg)](https://crates.io/crates/termscp) [![Crates.io](https://img.shields.io/badge/crates.io-v0.1.3-orange.svg)](https://crates.io/crates/termscp) [![Docs](https://docs.rs/termscp/badge.svg)](https://docs.rs/termscp) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Stars](https://img.shields.io/github/stars/ChristianVisintin/TermSCP.svg)](https://github.com/ChristianVisintin/TermSCP) [![Issues](https://img.shields.io/github/issues/ChristianVisintin/TermSCP.svg)](https://github.com/ChristianVisintin/TermSCP/issues) [![Downloads](https://img.shields.io/crates/d/termscp.svg)](https://crates.io/crates/termscp) [![Crates.io](https://img.shields.io/badge/crates.io-v0.2.0-orange.svg)](https://crates.io/crates/termscp) [![Docs](https://docs.rs/termscp/badge.svg)](https://docs.rs/termscp) [![Build](https://github.com/ChristianVisintin/TermSCP/workflows/Linux/badge.svg)](https://github.com/ChristianVisintin/TermSCP/actions) [![Build](https://github.com/ChristianVisintin/TermSCP/workflows/MacOS/badge.svg)](https://github.com/ChristianVisintin/TermSCP/actions) [![Build](https://github.com/ChristianVisintin/TermSCP/workflows/Windows/badge.svg)](https://github.com/ChristianVisintin/TermSCP/actions) [![codecov](https://codecov.io/gh/ChristianVisintin/termscp/branch/main/graph/badge.svg?token=au67l7nQah)](https://codecov.io/gh/ChristianVisintin/termscp) ~ Basically, WinSCP on a terminal ~ Developed by Christian Visintin -Current version: 0.1.3 (13/12/2020) +Current version: 0.2.0 (21/12/2020) --- @@ -18,6 +18,7 @@ Current version: 0.1.3 (13/12/2020) - [Cargo ๐Ÿฆ€](#cargo-) - [Deb package ๐Ÿ“ฆ](#deb-package-) - [RPM package ๐Ÿ“ฆ](#rpm-package-) + - [AUR Package](#aur-package) - [Chocolatey ๐Ÿซ](#chocolatey-) - [Brew ๐Ÿป](#brew-) - [Usage โ“](#usage-) @@ -78,8 +79,8 @@ cargo install termscp ### Deb package ๐Ÿ“ฆ -Get `deb` package from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp_0.1.3_amd64.deb) -or run `wget https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp_0.1.3_amd64.deb` +Get `deb` package from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp_0.2.0_amd64.deb) +or run `wget https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp_0.2.0_amd64.deb` then install through dpkg: @@ -91,8 +92,8 @@ gdebi termscp_*.deb ### RPM package ๐Ÿ“ฆ -Get `rpm` package from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp-0.1.3-1.x86_64.rpm) -or run `wget https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp-0.1.3-1.x86_64.rpm` +Get `rpm` package from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp-0.2.0-1.x86_64.rpm) +or run `wget https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp-0.2.0-1.x86_64.rpm` then install through rpm: @@ -100,6 +101,14 @@ then install through rpm: rpm -U termscp_*.rpm ``` +### AUR Package + +On Arch Linux based distribution, you can install termscp using for example [yay](https://github.com/Jguer/yay), which I recommend to install AUR packages. + +```sh +yay -S termscp +``` + ### Chocolatey ๐Ÿซ You can install TermSCP on Windows using [chocolatey](https://chocolatey.org/) @@ -110,7 +119,7 @@ Start PowerShell as administrator and run choco install termscp ``` -Alternatively you can download the ZIP file from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp.0.1.3.nupkg) +Alternatively you can download the ZIP file from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp.0.2.0.nupkg) and then with PowerShell started with administrator previleges, run: @@ -231,32 +240,32 @@ Text editor is automatically found using this [awesome crate](https://github.com ## Keybindings โŒจ -| Key | Command | -|---------------|-------------------------------------------------------| -| `` | Disconnect from remote; return to authentication page | -| `` | Switch between log tab and explorer | -| `` | Go to previous directory in stack | -| `` | Move to remote explorer tab | -| `` | Move to local explorer tab | -| `` | Move up in selected list | -| `` | Move down in selected list | -| `` | Move up in selected list by 8 rows | -| `` | Move down in selected list by 8 rows | -| `` | Enter directory | -| `` | Upload / download selected file | -| `` | Copy file/directory | -| `` | Make directory | -| `` | Delete file (Same as `CANC`) | -| `` | Go to supplied path | -| `` | Show help | -| `` | Show info about selected file or directory | -| `` | Reload current directory's content | -| `` | Edit file; see [Text editor](#text-editor-) | -| `` | Quit TermSCP | -| `` | Rename file | -| `` | Go to parent directory | -| `` | Delete file | -| `` | Abort file transfer process | +| Key | Command | Reminder | +|---------------|-------------------------------------------------------|-----------| +| `` | Disconnect from remote; return to authentication page | | +| `` | Switch between log tab and explorer | | +| `` | Go to previous directory in stack | | +| `` | Move to remote explorer tab | | +| `` | Move to local explorer tab | | +| `` | Move up in selected list | | +| `` | Move down in selected list | | +| `` | Move up in selected list by 8 rows | | +| `` | Move down in selected list by 8 rows | | +| `` | Enter directory | | +| `` | Upload / download selected file | | +| `` | Copy file/directory | Copy | +| `` | Make directory | Directory | +| `` | Delete file (Same as `CANC`) | Erase | +| `` | Go to supplied path | Go to | +| `` | Show help | Help | +| `` | Show info about selected file or directory | Info | +| `` | Reload current directory's content | List | +| `` | Edit file; see [Text editor](#text-editor-) | Open | +| `` | Quit TermSCP | Quit | +| `` | Rename file | Rename | +| `` | Go to parent directory | Upper | +| `` | Delete file | | +| `` | Abort file transfer process | | --- @@ -277,6 +286,10 @@ The developer documentation can be found on Rust Docs at