Add build from source instructions
This commit is contained in:
parent
3e3786dd92
commit
60e9cae89c
2 changed files with 13 additions and 7 deletions
|
@ -1,7 +1,7 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<project version="4">
|
<project version="4">
|
||||||
<component name="ExternalStorageConfigurationManager" enabled="true" />
|
<component name="ExternalStorageConfigurationManager" enabled="true" />
|
||||||
<component name="ProjectRootManager" version="2" languageLevel="JDK_19" default="true" project-jdk-name="19" project-jdk-type="JavaSDK">
|
<component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="openjdk-21" project-jdk-type="JavaSDK">
|
||||||
<output url="file://$PROJECT_DIR$/out" />
|
<output url="file://$PROJECT_DIR$/out" />
|
||||||
</component>
|
</component>
|
||||||
</project>
|
</project>
|
18
README.md
18
README.md
|
@ -1,18 +1,24 @@
|
||||||
# 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
|
||||||
2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)
|
~~2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~
|
||||||
3. Extract and run .jar
|
~~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. Make sure you have JRE-19
|
2. Make sure you have JRE-21
|
||||||
2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)
|
~~2. [Download Latest Release](https://git.ouroboros.group/limepotato/kotRemote/releases)~~
|
||||||
3. Extract and run .jar
|
~~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
|
### 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,
|
||||||
|
|
Loading…
Reference in a new issue