Cleanup and Clarify README.md
This commit is contained in:
parent
eae6909df9
commit
979aba1c77
1 changed files with 10 additions and 4 deletions
14
README.md
14
README.md
|
@ -1,16 +1,22 @@
|
|||
# kotRemote
|
||||
Wrapper for sshfs, built in Kotlin, and utilizes [Jexer](https://git.ouroboros.group/limepotato/jexer)
|
||||
|
||||
|
||||
## Installation Instructions:
|
||||
### Linux:
|
||||
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:
|
||||
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
|
||||
|
||||
This project falls under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
see [LICENSE.md](LICENSE.md)
|
Loading…
Reference in a new issue