Skip to content

Commit

Permalink
update readme part 3
Browse files Browse the repository at this point in the history
  • Loading branch information
josueBarretogit committed Aug 4, 2024
1 parent f82fce0 commit 6efe9ec
Showing 1 changed file with 52 additions and 15 deletions.
67 changes: 52 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,45 @@
<h1 align="center">
<strong>Manga-tui </strong>
<strong> 📖 Manga-tui 🖥️ </strong>
</h1>

<h3 align="center">
Terminal manga reader and downloader
</h3>

<p align="center">

<p align="center">

https://github.com/user-attachments/assets/2b693bd3-ec30-4d6e-bcc4-6cf457a860b1


</p>




## Table of contents

- [Features](#features)
- [Installation](#installation)
- [Image rendering](#image-rendering)
- [Usage](#usage)
- [Configuration](#configuration)
- [Motivation](#motivation)
- [Credits](#credits)

## Features

- Read manga in your terminal (If it supports graphical protocols like : Wezterm, iterm2, Kitty)

https://github.com/user-attachments/assets/70f321ff-13d1-4c4b-9c37-604271456ab2


- Advanced search (with filters)

https://github.com/user-attachments/assets/c1e21aa1-8a51-4c47-baea-9f56dcd0d6a4

- Read manga in your terminal

https://github.com/user-attachments/assets/70f321ff-13d1-4c4b-9c37-604271456ab2

- Reading history is stored locally (with no login required)
- https://github.com/user-attachments/assets/47e88e89-f73c-4575-9645-2abb80ca7d63

- Download manga
https://github.com/user-attachments/assets/47e88e89-f73c-4575-9645-2abb80ca7d63

- Download manga

https://github.com/user-attachments/assets/64880a98-74c8-4656-8cf8-2c1daf5375d2

Expand All @@ -54,6 +52,10 @@ https://github.com/user-attachments/assets/64880a98-74c8-4656-8cf8-2c1daf5375d2
cargo install manga-tui
```

## Image rendering

Use a terminal that can render images such as Wezterm, iTerm2 or Kitty, in any other terminal no images
will be rendered but all the functionality remains the same

## Usage

Expand All @@ -63,7 +65,7 @@ After installation run the binary
manga-tui
```

Manga and reading history is stored in the `manga-tui` directory, to know where it is run:
Manga downloads and reading history is stored in the `manga-tui` directory, to know where it is run:


```shell
Expand All @@ -74,6 +76,41 @@ manga-tui --data-dir
manga-tui -d
```

On linux it will output something like: `~/.local/share/manga-tui`
If you want to change the location you can set the environment variable `MANGA_TUI_DATA_DIR` to some path pointing to a directory, example: /home/user/somedirectory
On linux it will output something like: `~/.local/share/manga-tui` <br />

On the `manga-tui` directory there will be 3 directories
- `history`, which contains a sqlite database to store reading history
- `mangaDownloads`, where manga will be downloaded
- `errorLogs`, for storing posible errors / bugs

If you want to change the location you can set the environment variable `MANGA_TUI_DATA_DIR` to some path pointing to a directory, like: <br />

export MANGA_TUI_DATA_DIR="/home/user/Desktop/mangas"

## Configuration

By default `manga-tui` will search mangas in english, you can change the language by running:


```shell
# `es` corresponds to the Iso code for spanish
manga-tui lang --set 'es'
```

Check the available languages by running:


```shell
manga-tui lang --print
```

## Motivation
I wanted to make a "How linux user does ..." but for manga, [here is the video](https://www.youtube.com/watch?v=K0FsGRqEc1c)

## Credits

Many thanks to Mangadex for providing the free API please consider supporting them ❤️ <br />
Many thanks to [Ratatui](https://github.com/ratatui-org) for making such a good library for making TUI's 🐭 <br />
Many thanks to the developer of the [Ratatui-image crate](https://crates.io/crates/ratatui-image) for providing a widget that renders images in the terminal 🖼️ <br />

Consider giving a start to this project ⭐

0 comments on commit 6efe9ec

Please sign in to comment.