limepotato/kotRemote
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Lint!

Browse source
This commit is contained in:
nelle 2024-02-19 16:23:04 -07:00
parent af7dd53af9
commit ca0b60341a
1 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,29 +1,36 @@
# kotRemote # kotRemote
Wrapper for sshfs, built in Kotlin, and utilizes [Jexer](https://git.ouroboros.group/limepotato/jexer) Wrapper for sshfs, built in Kotlin, and utilizes [Jexer](https://git.ouroboros.group/limepotato/jexer)
## Installation Instructions: ## Installation Instructions
### Linux:
### Linux
1. install `openssh-askpass`(Or any graphical ssh/askpass program) & `sshfs` 1. install `openssh-askpass`(Or any graphical ssh/askpass program) & `sshfs`
2. Make sure you have JRE-19 2. Make sure you have JRE-19
3. ~~[Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~ 3. ~~[Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~
4. ~~Extract and run .jar~~ 4. ~~Extract and run .jar~~
### Windows: ### Windows
1. install [sshfs-win](https://github.com/winfsp/sshfs-win) 1. install [sshfs-win](https://github.com/winfsp/sshfs-win)
2. Make sure you have JRE-21 2. Make sure you have JRE-21
3. ~~[Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~ 3. ~~[Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~
4. ~~Extract and run .jar~~ 4. ~~Extract and run .jar~~
### Build from Source: ### Build from Source
1. clone the repository `git clone https://git.ouroboros.group/limepotato/kotRemote.git`
2. enter directory cloned `cd kotRemote` 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` 3. Open terminal and run `./gradlew shadow jar`
4. Find the built jar under `build/libs/kotRemote{version}-all.jar` 4. Find the built jar under `build/libs/kotRemote{version}-all.jar`
### CMDLine Options ### 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. Please note that, in XTERM or ECMA48 mode, the login process may break the graphical interface.
## LICENSE ## LICENSE
This project falls under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
see [LICENSE.md](LICENSE.md) This project falls under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
see [LICENSE.md](LICENSE.md)