aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarvin Borner2019-05-01 15:33:42 +0200
committerMarvin Borner2019-05-01 15:33:42 +0200
commit8549c68cfcf4caabb696152f36facc074129ebcf (patch)
tree35281a88f1894cf3b96c938373a249548bfe5e04 /README.md
parenta3c10541f945068265d93ae83753dda0ac361164 (diff)
Added deployment features and functionalityv0.1-BETA
Co-authored-by: LarsVomMars <lars@kroenner.eu>
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 765640a..8c424e6 100644
--- a/README.md
+++ b/README.md
@@ -17,10 +17,17 @@
- Supports Windows, MacOS, Linux and *BSD
- Open source
+## Installation
+To install and run Kloud, you can either download the latest release on GitHub or use the "Development setup" instructions
+below to build an executable yourself.
+After that you can easily start the server via `java -jar kloud-VERSION-all.jar`
+
## Development setup
-* Setup JVM Environment
+* Setup Java JDK and JRE Environment
+* Install Gradle
* Clone repository
-* `./gradlew[.bat] run`
+* `gradle run`
+* For building, use: `gradle build`
## Help us with a small donation :)
<p align="center">