From 60e9cae89c3f8d7b1a6653da31843169fa80b854 Mon Sep 17 00:00:00 2001 From: limepotato Date: Mon, 19 Feb 2024 16:21:16 -0700 Subject: [PATCH] Add build from source instructions --- .idea/misc.xml | 2 +- README.md | 18 ++++++++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.idea/misc.xml b/.idea/misc.xml index 73e812d..9fc492e 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -1,7 +1,7 @@ - + \ No newline at end of file diff --git a/README.md b/README.md index 8ec9c26..1f2aee1 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ # kotRemote Wrapper for sshfs, built in Kotlin, and utilizes [Jexer](https://git.ouroboros.group/limepotato/jexer) -## Installation Instructions: +## Installation Instructions: ### Linux: 1. install `openssh-askpass`(Or any graphical ssh/askpass program) & `sshfs` 2. Make sure you have JRE-19 -2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases) -3. Extract and run .jar + ~~2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~ + ~~3. Extract and run .jar~~ ### Windows: 1. install [sshfs-win](https://github.com/winfsp/sshfs-win) -2. Make sure you have JRE-19 -2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases) -3. Extract and run .jar +2. Make sure you have JRE-21 + ~~2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~ + ~~3. 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` +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,