From 94c6f339256e129007905256832e1782ea0b122d Mon Sep 17 00:00:00 2001 From: Aria Moradi Date: Sat, 23 Jan 2021 00:23:40 +0330 Subject: [PATCH 1/3] Update README.md --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5ab98ec..ac8aac5 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,10 @@ Tachidesk is as multi-platform as you can get. Any platform that runs java and/o Ability to read and write Tachiyomi compatible backups and syncing is a planned feature. -## How does it work? -This project has two components: -1. **server:** contains the implementation of [tachiyomi's extensions library](https://github.com/tachiyomiorg/extensions-lib) and uses an Android compatibility library to run apk extensions. All this concludes to serving a REST API to `webUI`. -2. **webUI:** A react SPA project that works with the server to do the presentation. - ## How do I run the thing? +#### Prerequisites +You should have java 8 or newer 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). @@ -18,6 +16,11 @@ 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` open this url in your browser. +## How does it work? +This project has two components: +1. **server:** contains the implementation of [tachiyomi's extensions library](https://github.com/tachiyomiorg/extensions-lib) and uses an Android compatibility library to run apk extensions. All this concludes to serving a REST API to `webUI`. +2. **webUI:** A react SPA project that works with the server to do the presentation. + ## Building from source ### Get Android stubs jar #### Manual download @@ -37,7 +40,11 @@ How to do it is described in `webUI/react/README.md` but for short, and supports HMR and all the other goodies you'll need. ## Is this application usable? Should I test it? -Checkout [the state of project](https://github.com/AriaMoradi/Tachidesk/issues/2) to see what's implemented. +If you'd ask me, I'd tell you If you want to read your manga **online** from tachiyomi or in one place and bypass all the ads, you can use Tachidesk. + +There is almost no quality of life feature and no library and downloading and sadly no MangaDex search. + +Anyways, for more info checkout [finished milestone #1](https://github.com/AriaMoradi/Tachidesk/issues/2) and [milestone #2](https://github.com/AriaMoradi/Tachidesk/projects/1) 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`. From 15a2115c5a8d990fbb52d1339c7db83d24e742b0 Mon Sep 17 00:00:00 2001 From: Aria Moradi Date: Sat, 23 Jan 2021 00:26:43 +0330 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ac8aac5..9019751 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ How to do it is described in `webUI/react/README.md` but for short, ## Is this application usable? Should I test it? If you'd ask me, I'd tell you If you want to read your manga **online** from tachiyomi or in one place and bypass all the ads, you can use Tachidesk. -There is almost no quality of life feature and no library and downloading and sadly no MangaDex search. +There are almost no quality of life features including no library, no downloading for offline enjoyment and sadly no MangaDex search. Anyways, for more info checkout [finished milestone #1](https://github.com/AriaMoradi/Tachidesk/issues/2) and [milestone #2](https://github.com/AriaMoradi/Tachidesk/projects/1) to see what's implemented. From e219179519d8e9b1b33aa3b48e920ae25dc26aa5 Mon Sep 17 00:00:00 2001 From: Aria Moradi Date: Sat, 23 Jan 2021 00:28:32 +0330 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9019751..161aa35 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ How to do it is described in `webUI/react/README.md` but for short, ## Is this application usable? Should I test it? If you'd ask me, I'd tell you If you want to read your manga **online** from tachiyomi or in one place and bypass all the ads, you can use Tachidesk. -There are almost no quality of life features including no library, no downloading for offline enjoyment and sadly no MangaDex search. +There are almost no quality of life features, including no library, no downloading for offline enjoyment and sadly no MangaDex search. Anyways, for more info checkout [finished milestone #1](https://github.com/AriaMoradi/Tachidesk/issues/2) and [milestone #2](https://github.com/AriaMoradi/Tachidesk/projects/1) to see what's implemented.