From 09fb9521c16a4c90fcda1d4c976fe1eb071d0e3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Vitor?= Date: Wed, 11 May 2022 17:49:45 -0300 Subject: [PATCH] new --- README.md | 171 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 169 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8d2f3a72..85ee91c8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,169 @@ -# Tachidesk-Sorayomi -A free and open source manga reader based on Flutter to read manga from a Tachidesk-Server instance. +

+ Tachidesk Sorayomi logo +

+ +

Tachidesk Sorayomi

+ +
+ +[![Platform](https://img.shields.io/badge/platform-Android%20%7C%20iOS%20%7C%20Linux%20%7C%20Windows%20%7C%20MacOS%20%7C%20Web-lightgrey)][release] +[![Discord](https://img.shields.io/discord/801021177333940224.svg?label=discord&labelColor=7289da&color=2c2f33&style=flat)](https://discord.gg/DDZdqZWaHA) + +
+ +
+ +[![GitHub Stars](https://img.shields.io/github/stars/Suwayomi/Tachidesk-Sorayomi)](https://github.com/Suwayomi/Tachidesk-Sorayomi) +[![GitHub License](https://img.shields.io/github/license/Suwayomi/Tachidesk-Sorayomi)](https://github.com/Suwayomi/Tachidesk-Sorayomi/blob/main/LICENSE) +![CI](https://github.com/Suwayomi/Tachidesk-Sorayomi/actions/workflows/publish.yml/badge.svg) +[![stable release](https://img.shields.io/github/release/Suwayomi/Tachidesk-Sorayomi.svg?maxAge=3600&label=download)](https://github.com/Suwayomi/Tachidesk-Sorayomi/releases) + +
+ + + +

+A free and open source manga reader based on Flutter to read manga from a Tachidesk-Server instance.

+Tachidesk-Sorayomi need to connect with an already hosted server.

+Tachidesk-Sorayomi supports Linux, Windows, MacOS, Web, iOS and Android. +

+ +--- + +## Is this application usable? Should I test it? + +Here is a list of current features for interaction with Tachidesk-Sorayomi: + +- Managing installed Extensions. +- Interaction with your library. +- Browsing installed sources. +- Viewing manga and chapters. +- Reading, downloading, and managing chapters. +- Viewing chapter updates + +**Note:** Keep in mind that Tachidesk-Sorayomi and Tachidesk-Server are alpha software, so it can have issues. See [Support and help](#support-and-help) if it happens. + + +### Supported Tachidesk versions + +These are the versions of [Tachidesk-Server][tachidesk-server] that Tachidesk-Sorayomi supports. + +#### [Release build][release] + +- [Tachidesk-Server][tachidesk-server] v0.6.0+ + + +## Downloading and Running the app + +### Android + +Download the latest apk file from [the releases section][release]. + + +### iOS + +Download the latest ipa file from [the releases section][release]. + +### Windows + +Download the latest msi file from [the releases section][release]. + +### MacOS + +Download the latest dmg release from [the releases section][release]. + +### Debian based Linux + +Download the latest deb release from [the releases section][release]. + +### Arch based Linux + +Download the latest release from [the aur](https://aur.archlinux.org/packages/tachidesk-sorayomi-bin). + +If you use yay, you can run +``` +yay -S tachidesk-sorayomi-bin +``` +inside a terminal window. + +### Web + +Download the latest web.zip file from [the releases section][release]. + + +## Post installation + + - Configure your server address in `Navigation bar > more screen > Server URL`. + +## Building from source + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. + +### Prerequisites + +You can install Flutter & Dart from [Official website](https://docs.flutter.dev/get-started/install) +``` + $ Dart sdk + $ Flutter - Channel beta +``` + +### Building + +1. Clone the repository: + +``` + $ git clone https://github.com/Suwayomi/Tachidesk-Sorayomi.git + $ cd Tachidesk-Sorayomi/ +``` +2. You can install all dependencies by running this command in terminal: + +``` + $ flutter pub get +``` + +3. Now enter the following command to start debugging the app: + +``` + $ flutter run +``` + + +## Support and help + +- Join Tachidesk's [discord server](https://discord.gg/DDZdqZWaHA) to hang out with the community and receive support and help. + + +## Built Using + +- [Flutter](https://flutter.dev/) - Flutter is an open source framework by Google for building beautiful, natively compiled, multi-platform applications from a single codebase. +- [Flutter Getx](https://pub.dev/packages/get) - State, Navigation & Dependencies Manager +- [Flutter Getx Pattern](https://github.com/kauemurakami/getx_pattern) - A proposal to standardize your development with GetX (File structure). + + Find other dependencies in [pubspec.yaml](pubspec.yaml) + +## Credit + +- The `Tachidesk-server` project is developed by [@AriaMoradi](https://github.com/AriaMoradi) and contributors, + +- The `Tachidesk-Sorayomi` project is developed by [@DattatreyaReddy](https://github.com/DattatreyaReddy) and contributors, + +- CI-CD for `Tachidesk-Sorayomi` is developed by [@mahor1221](https://github.com/mahor1221) and contributors. + + +## License + +A link for [Tachidesk is provided here](https://github.com/Suwayomi/Tachidesk) and is licensed under `Mozilla Public License v2.0`. + +You can obtain a copy of `Mozilla Public License v2.0` from https://mozilla.org/MPL/2.0/ + + + Copyright (C) Contributors to the Suwayomi project + + 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 + file, You can obtain one at http://mozilla.org/MPL/2.0/. + + +[release]: https://github.com/Suwayomi/Tachidesk-Sorayomi/releases +[tachidesk-server]: https://github.com/Suwayomi/Tachidesk-Server +[tachidesk-server-preview]: https://github.com/Suwayomi/Tachidesk-Server-preview/releases \ No newline at end of file