diff --git a/README.md b/README.md index 91d00475..3f8b8f38 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Ability to read and write Tachiyomi compatible backups and syncing is a planned ## How do I run the thing? #### Prerequisites -You should have The Java Runtime Environment(JRE) 8 or newer and a modern browser installed. Also an internet connection is required as almost everything this app does is downloading stuff. +You should have The Java Runtime Environment(JRE) 8 or newer (if you're not planning to use the Windows specific build) and a modern browser installed. Also an internet connection is required as almost everything this app does is downloading stuff. #### Running pre-built jar packages Download the latest (or a working more stable) release from [the repo branch](https://github.com/AriaMoradi/Tachidesk/tree/repo) or obtain it from [the releases section](https://github.com/AriaMoradi/Tachidesk/releases). @@ -16,7 +16,7 @@ Double click on the jar file or run `java -jar Tachidesk-latest.jar` or `java -j The server will be running on `http://localhost:4567`. A new browser window will be opened automatically. Also the System Tray Icon is your friend if you need to open the browser window again or close Tachidesk. -#### Running pre-built windows packages +#### Running pre-built Windows packages Windows specific builds have java bundled inside them. Download the zip release insted of the jar release which is named `Tachidesk-latest-win32.zip` or `Tachidesk-vX.Y.Z-rxxx-win32.zip`, unizp it and run `server.exe`. #### Running on Docker @@ -26,11 +26,11 @@ Check [arbuilder's repo](https://github.com/arbuilder/Tachidesk-docker) out for ### Get Android stubs jar #### Manual download Download [android.jar](https://raw.githubusercontent.com/AriaMoradi/Tachidesk/android-jar/android.jar) and put it under `AndroidCompat/lib`. -#### Building from source(needs `bash`, `curl`, `base64`, `zip` to work) +#### Automated download(needs `bash`, `curl`, `base64`, `zip` to work) Run `scripts/getAndroid.sh` from project's root directory to download and rebuild the jar file from Google's repository. ### building the jar Run `./gradlew shadowJar`, the resulting built jar file will be `server/build/Tachidesk-vX.Y.Z-rxxx.jar`. -### building windows package +### building the Windows package Run `./gradlew windowsPackage`, the resulting built zip package file will be `server/build/Tachidesk-vX.Y.Z-rxxx-win32.zip`. ## Running for development purposes ### `server` module