diff --git a/README.md b/README.md index 09909188..3af37fb3 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,28 @@ This project has two components: 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) 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 :server:shadowJar` the resulting jar file will be `server/build/server-1.0-all.jar`. Simply double click on it or run `java -jar server-1.0-all.jar`. The server will be running on `http://localhost:4567` open this url in your browser. +## running for development purposes ### The Server -run `./gradlew :server:run` to run the server +run `./gradlew :server:run -x :webUI:copyBuild --stacktrace` to run the server ### the 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) then `yarn start` to start the client if a new browser window doesn't start automatically, then open `http://127.0.0.1:3000` in a modern browser. -## Can I use this application? +## Is the application usable? Should I test it? Checkout [the state of project](https://github.com/AriaMoradi/Tachidesk/issues/2) to see what's implemented. +## Credit +The `AndroidCompat` module and `scripts/getAndroid.sh` was originally developed by [@null-dev](https://github.com/null-dev) for [TachiWeb-Server](https://github.com/Tachiweb/TachiWeb-server) and is licensed under `Apache License Version 2.0`. + +Parts of [tachiyomi](https://github.com/tachiyomiorg/tachiyomi) is adopted into this codebase, also licensed under `Apache License Version 2.0`. + ## License - Copyright (C) 2020 Aria Moradi + Copyright (C) 2020-2021 Aria Moradi and contributors This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this