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

Cleanup and Clarify README.md

Browse source
This commit is contained in:
nelle 2024-02-17 04:34:45 -07:00
parent eae6909df9
commit 979aba1c77
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,16 +1,22 @@
# 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` && `sshfs` 1. install `openssh-askpass` && `sshfs`
2. download and run and enjoy wowzises 2. Make sure you have JRE-19
2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)
3. 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. run and enjoy wowwoww 2. Make sure you have JRE-19
2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)\
3. Extract and run .jar
### CMDLine Options
`java -jar -Djexer.Swing=false` to disable graphical interface, and force XTERM
## LICENSE ## LICENSE
This project falls under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) This project falls under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
see [LICENSE.md](LICENSE.md) see [LICENSE.md](LICENSE.md)