Skip to content

Latest commit

 

History

History
200 lines (121 loc) · 6.35 KB

README.md

File metadata and controls

200 lines (121 loc) · 6.35 KB
Raw

Tachidesk Sorayomi logo

Tachidesk Sorayomi

Platform Discord

GitHub Stars GitHub License CI stable release

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 if it happens.

Supported Tachidesk versions

These are the versions of Tachidesk-Server that Tachidesk-Sorayomi supports.

Release build

Downloading and Running the app

Android

Download *-android-all.apk file from latest release the releases section.

iOS

Windows

Download the latest .msi file from the releases section.

if you use WINGET, you can run

winget install tachidesk-sorayomi

MacOS

  • Download the *-macos-x64.zip from the latest release the releases section
  • Extract the file.
  • Drag and drop the extracted app file to applications folder in finder.

if you use HomeBrew, you can run

brew install --cask tachidesk-sorayomi

Debian based Linux

Download the latest deb release from the releases section.

Arch based Linux

Download the latest release from the aur.

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.

  • Sorayomi-web deployed in GitHub pages. You can check out Sorayomi here.

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

  • Dart sdk
  • Flutter - Channel Stable

Building

  1. Clone the repository:
  $ git clone https://github.com/Suwayomi/Tachidesk-Sorayomi.git
  $ cd Tachidesk-Sorayomi/
  1. You can install all dependencies by running this command in terminal:
  $ flutter pub get
  1. Now enter the following command to start debugging the app:
  $ flutter run
  • Localization generator
  $ flutter gen-l10n
  • Pull-Request Suggestion
    • Install GitHooks after cloning the repo using git config --local core.hooksPath .githooks

Support and help

  • Join Tachidesk's discord server to hang out with the community and receive support and help.

Built Using

  • Flutter is an open source framework by Google for building beautiful, natively compiled, multi-platform applications from a single codebase.

  • Flutter Riverpod - A simple way to access state while robust and testable.

  • Riverpod Architecture - File architecture developed by @bizz84

Find other dependencies in pubspec.yaml

Credit

  • The Tachidesk-server project is developed by @AriaMoradi and contributors,

  • The Tachidesk-Sorayomi project is developed by @DattatreyaReddy and contributors,

  • CI-CD for Tachidesk-Sorayomi is developed by @mahor1221 and contributors.

Translation

Feel free to translate the project on Weblate

Translation Progress Translation status

License

A link for Tachidesk is provided here 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/.