From 45a6abc5c206a45e51d5044af946ef52c5dce38e Mon Sep 17 00:00:00 2001 From: Aria Moradi Date: Fri, 7 May 2021 19:13:04 +0430 Subject: [PATCH] [SKIP CI] improve structure --- CONTRIBUTING.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb772fde..11f1a1ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,14 +20,14 @@ Currently there are three known interfaces for Tachidesk: 3. [Equinox](https://github.com/Suwayomi/Equinox): A web user interface made with Vue.js, in super early stages of development. ## Building from source -### Prerequisite: Get Android stubs jar -#### Manual download -Download [android.jar](https://raw.githubusercontent.com/Suwayomi/Tachidesk/android-jar/android.jar) and put it under `AndroidCompat/lib`. -#### Automated download -Run `AndroidCompat/getAndroid.sh`(MacOS/Linux) or `AndroidCompat/getAndroid.ps1`(Windows) from project's root directory to download and rebuild the jar file from Google's repository. -### Prerequisite: Software dependencies -You need this software packages installed in order to build this project: +### Prerequisites +You need these software packages installed in order to build the project +### Server - Java Development Kit and Java Runtime Environment version 8 or newer(both Oracle JDK and OpenJDK works) +- Android stubs jar + - Manual download: Download [android.jar](https://raw.githubusercontent.com/Suwayomi/Tachidesk/android-jar/android.jar) and put it under `AndroidCompat/lib`. + - Automated download: Run `AndroidCompat/getAndroid.sh`(MacOS/Linux) or `AndroidCompat/getAndroid.ps1`(Windows) from project's root directory to download and rebuild the jar file from Google's repository. +### webUI - Nodejs LTS or latest - Yarn - Git @@ -38,8 +38,9 @@ Delete the `server/src/main/resources/react` directory if exists from previous r ### building the Windows package Run `./gradlew :server:windowsPackage` to build a server only bundle and `./gradlew :webUI:copyBuild :server:windowsPackage` to get a full bundle , the resulting built zip package file will be `server/build/Tachidesk-vX.Y.Z-rxxx-win32.zip`. ## Running in development mode +First satistify [the prerequisites](#prerequisites) ### server -Follow [Get Android stubs jar](#prerequisite-get-android-stubs-jar) then run `./gradlew :server:run --stacktrace` to run the server +run `./gradlew :server:run --stacktrace` to run the server ### webUI How to do it is described in `webUI/react/README.md` but for short, first cd into `webUI/react` then run `yarn` to install the node modules(do this only once)