altoku/README.md

29 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2024-05-28 10:37:10 +01:00
# Altoku
`altoku` is a TUI japanese media aggregate written in Rust.
## Features
Here's a featurelist for *a finished* `altoku`:
- Watch anime
- Fetch anime
- Fetch manga
- Fetch light novels
- Anilist integration
Altoku is actively being worked on, but as of writing has very little functionality for what it intends to be.
## Installation
To build `altoku`, you'll need [Rust](https://rust-lang.org) installed:
```bash
$ git clone https://git.devraza.giize.com/devraza/altoku
$ cd altoku
$ cargo build --release # `--release` adds a few optimisations
```
> **Using the flake!**
> This repository contains a `flake.nix` - if you have Nix installed, you can run `nix run github:devraza/altoku` to compile and run the program.
## Disclaimer
All content accessible through the project is unaffiliated with the project or its developer(s), and so any copyrighted content that can be accessed by the user is accessed entirely at the user's own risk - this project and its developer(s) are not responsible for any theft of intellectual property or other harm done by users through this program and its code, `altoku`.