From ca0b60341a929bb3bb5c3d42a2c49026786d1073 Mon Sep 17 00:00:00 2001 From: limepotato Date: Mon, 19 Feb 2024 16:23:04 -0700 Subject: [PATCH] Lint! --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d15fad4..88a8178 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,36 @@ # kotRemote + Wrapper for sshfs, built in Kotlin, and utilizes [Jexer](https://git.ouroboros.group/limepotato/jexer) -## Installation Instructions: -### Linux: +## Installation Instructions + +### Linux + 1. install `openssh-askpass`(Or any graphical ssh/askpass program) & `sshfs` 2. Make sure you have JRE-19 3. ~~[Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~ 4. ~~Extract and run .jar~~ -### Windows: +### Windows + 1. install [sshfs-win](https://github.com/winfsp/sshfs-win) 2. Make sure you have JRE-21 3. ~~[Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~ 4. ~~Extract and run .jar~~ -### Build from Source: -1. clone the repository `git clone https://git.ouroboros.group/limepotato/kotRemote.git` -2. enter directory cloned `cd kotRemote` +### Build from Source + +1. Clone the repository `git clone https://git.ouroboros.group/limepotato/kotRemote.git` +2. Enter directory cloned `cd kotRemote` 3. Open terminal and run `./gradlew shadow jar` 4. Find the built jar under `build/libs/kotRemote{version}-all.jar` ### CMDLine Options -`java -jar -Djexer.Swing=false` to disable graphical interface, and force XTERM, + +`java -jar -Djexer.Swing=false` to disable graphical interface, and force XTERM, Please note that, in XTERM or ECMA48 mode, the login process may break the graphical interface. ## LICENSE -This project falls under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) -see [LICENSE.md](LICENSE.md) \ No newline at end of file + +This project falls under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) +see [LICENSE.md](LICENSE.md)