Skip to content

Commit

Permalink
docs: compact readme (#1202)
Browse files Browse the repository at this point in the history
  • Loading branch information
@port19x
port19x authored Aug 15, 2023
1 parent 3139832 commit 235dd10
Showing 1 changed file with 63 additions and 73 deletions.
136 changes: 63 additions & 73 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
<a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"></a>
<a href="#Linux"><img src="https://img.shields.io/badge/os-linux-brightgreen">
<a href="#MacOS"><img src="https://img.shields.io/badge/os-mac-brightgreen">
<a href="#Windows"><img src="https://img.shields.io/badge/os-windows-brightgreen">
<a href="#Android"><img src="https://img.shields.io/badge/os-android-brightgreen">
<a href="#iOS"><img src="https://img.shields.io/badge/os-ios-brightgreen">
<a href="#Steam-deck"><img src="https://img.shields.io/badge/os-steamdeck-brightgreen">
<a href="#Windows"><img src="https://img.shields.io/badge/os-windows-yellowgreen">
<a href="#iOS"><img src="https://img.shields.io/badge/os-ios-yellow">
<a href="#Steam-deck"><img src="https://img.shields.io/badge/os-steamdeck-yellow">
<br>
<h1 align="center">
<a href="https://discord.gg/aqu7GpqVmR">
Expand Down Expand Up @@ -35,17 +35,9 @@ A cli to browse and watch anime (alone AND with friends). This tool scrapes the

- [Fixing errors](#fixing-errors)
- [Install](#install)
- [Linux](#linux)
- [Debian](#debian-unstable)
- [Fedora](#fedora)
- [Arch](#arch)
- [OpenSuse Tumbleweed and Leap](#opensuse-tumbleweed-and-leap)
- [From source](#installing-from-source)
- [MacOS](#macos)
- [Windows](#windows)
- [Android](#android)
- [Steam Deck](#steam-deck)
- [iOS](#ios)
- [Tier 1: Linux, Mac, Android](#tier-1-support-linux-mac-android)
- [Tier 2: Windows, iOS, Steam Deck](#tier-2-support-windows-ios-steam-deck)
- [From Source](#installing-from-source)
- [Uninstall](#uninstall)
- [Dependencies](#dependencies-1)
- [Homies](#homies)
Expand All @@ -62,24 +54,27 @@ History has been reworked and relocated. We're working on a transition script, p

## Install

#### Users of V3.2 or the v3.2.x series should uninstall before upgrading
Otherwise you're likely to see an error like the following: ` "/usr/bin/ani-cli: line 470: (...)/player_mpv: No such file or directory"`
[![Packaging status](https://repology.org/badge/vertical-allrepos/ani-cli.svg?minversion=4.0)](https://repology.org/project/ani-cli/versions)

### Native packages
### Tier 1 Support: Linux, Mac, Android

[![Packaging status](https://repology.org/badge/vertical-allrepos/ani-cli.svg?minversion=4.0)](https://repology.org/project/ani-cli/versions)
*These Plattforms have rock solid support and are used by maintainers and large parts of the userbase.*

*Native packages have a more robust update cycle, but sometimes they are slow to upgrade. If the one for your platform is up-to-date we suggest going with it.*
<details><summary><b>Linux</b></summary>

### Linux
#### Native Packages

#### Debian unstable
*Native packages have a more robust update cycle, but sometimes they are slow to upgrade. \
If the one for your platform is up-to-date we suggest going with it.*

<details><summary>Debian unstable</summary>

```sh
sudo apt install ani-cli
```
</details>

#### Fedora
<details><summary>Fedora</summary>

To install mpv (and vlc) you need _RPM Fusion free_ enabled. Simply follow the instructions here: https://rpmfusion.org/Configuration
To be able to install syncplay, you'll need to enable this copr repo (instructions included): https://copr.fedorainfracloud.org/coprs/batmanfeynman/syncplay/.
Expand All @@ -91,15 +86,15 @@ sudo dnf install ani-cli
```
*If for your distro uses rpm and you would like to see a native package, open an issue.*

#### Arch
</details><details><summary>Arch</summary>

Build and install from the AUR:
```sh
yay -S ani-cli
```
Also consider `ani-cli-git`

#### Gentoo
</details><details><summary>Gentoo</summary>

Build and install from the GURU:
```sh
Expand All @@ -112,7 +107,7 @@ Consider using the 9999 ebuild.
sudo emerge -a =app-misc/ani-cli-9999
```

#### OpenSuse Tumbleweed and Leap
</details><details><summary>OpenSuse</summary>

On Suse the provided MPV and VLC packages are missing features that are used by ani-cli. The only required is the "Only Essentials" repository which has versions for each Suse release.
You can find instructions on this [here](https://en.opensuse.org/Additional_package_repositories#Packman).
Expand All @@ -127,25 +122,13 @@ You'll get a warning about `Signature verification failed [4-Signatures public k

*Note: package is noarch, so any architecture should work, even though the repo is labelled x86-64*

#### Installing from source

Install dependencies [(See below)](#dependencies-1)

```sh
sudo rm -rf "/usr/local/share/ani-cli" "/usr/local/bin/ani-cli" "/usr/local/bin/UI" /usr/local/bin/player_* #If some of these aren't found, it's not a problem
git clone "https://github.com/pystardust/ani-cli.git"
sudo cp ani-cli/ani-cli /usr/local/bin
rm -rf ani-cli
```

### MacOS
</details></details><details><summary><b>MacOS</b></summary>

Install dependencies [(See below)](#dependencies-1)

Install [HomeBrew](https://docs.brew.sh/Installation) if not installed.

```sh
rm -rf "$(brew --prefix)/share/ani-cli" "$(brew --prefix)/bin/ani-cli" "$(brew --prefix)/bin/UI" "$(brew --prefix)"/bin/player_* #If some of these aren't found, it's not a problem
git clone "https://github.com/pystardust/ani-cli.git" && cd ./ani-cli
cp ./ani-cli "$(brew --prefix)"/bin
cd .. && rm -rf ./ani-cli
Expand All @@ -159,7 +142,27 @@ brew install --cask iina
```
*Why iina and not mpv? Drop-in replacement for mpv for MacOS. Integrates well with OSX UI. Excellent support for M1. Open Source.*

### Windows
</details><details><summary><b>Android</b></summary>

Install termux [(Guide)](https://termux.com/)

#### Termux package

```sh
pkg up -y
pkg install ani-cli
```

For players you can use the apk (playstore/fdroid) versions of mpv and vlc. Note that these cannot be checked from termux so a warning is generated when checking dependencies.

</details>

### Tier 2 Support: Windows, iOS, Steam Deck

*While officially supported, installation is more involved on these plattforms and sometimes issues arise. \
Reach out if you need help.*

<details><summary><b>Windows</b></summary>

*ani-cli needs a posix shell and the current way is git bash. Unfortunately fzf can't run in git bash's default terminal. The solution is to use git bash in windows terminal*

Expand All @@ -169,21 +172,11 @@ Then make sure git bash is installed. [(Install)](https://git-scm.com/download/w

The following steps and ani-cli need to be run from git bash in windows terminal.

#### Scoop bucket

```sh
scoop bucket add extras
scoop install ani-cli
```

#### From source
```sh
rm -rf "/usr/local/share/ani-cli" "/usr/local/bin/ani-cli" "/usr/local/bin/UI" /usr/local/bin/player_* #If some of these aren't found, it's not a problem
git clone "https://github.com/pystardust/ani-cli.git"
cp ani-cli/ani-cli /usr/bin
rm -rf ani-cli
```

#### Dependencies

All dependencies can be installed with scoop (from the extras bucket), however some users experienced that installed programs aren't always added to the path. If this happens installing from winget instead usually works.
Expand All @@ -192,30 +185,8 @@ Note that curl can cause issues.
ani-cli has been tested unsuccessfully with curl `7.83.1` and successfully with `7.86.0`.
If you run into issues, try the scoop install or grab the newest curl you can find.

### Android

Install termux [(Guide)](https://termux.com/)

#### Termux package

```sh
pkg up -y
pkg install ani-cli
```

#### From source

```sh
pkg up -y
rm -rf "$PREFIX/share/ani-cli" "$PREFIX/bin/ani-cli" "$PREFIX/bin/UI" "$PREFIX"/local/bin/player_* #If some of these aren't found, it's not a problem
git clone "https://github.com/pystardust/ani-cli.git"
cp ani-cli/ani-cli "$PREFIX"/bin
rm -rf ani-cli
```

For players you can use the apk (playstore/fdroid) versions of mpv and vlc. Note that these cannot be checked from termux so a warning is generated when checking dependencies.
</details><details><summary><b>iOS</b></summary>

### iOS
Install iSH and VLC from the app store.

Make sure apk is updated using
Expand All @@ -238,8 +209,9 @@ chmod +x /usr/local/bin/ani-cli
rm -rf ~/.ani-cli
```
note that downloading is going to be very slow. This is an iSH issue, not an ani-cli issue.
</details>

### Steam Deck
<details><summary><b>Steam Deck</b></summary>

#### Copypaste script:

Expand Down Expand Up @@ -331,9 +303,24 @@ In Steam Desktop app:
`Add game` > `Add a non-steam game` > tick a box for `ani-cli` > `Add selected programs`
*Note: Konsole window size bugs out if launched from "Gaming Mode".*
*Note: this is not working the way it should yet.*
</details>

### Installing from source

*This method works for any unix-like operating system and is a baseline for porting efforts.*

Install dependencies [(See below)](#dependencies-1)

```sh
git clone "https://github.com/pystardust/ani-cli.git"
sudo cp ani-cli/ani-cli /usr/local/bin
rm -rf ani-cli
```

## Uninstall

<details>

* apt:
```sh
sudo apt remove ani-cli
Expand Down Expand Up @@ -408,6 +395,9 @@ To uninstall other dependencies:
```
apk del grep sed curl fzf git aria2 alpine-sdk ncurses
```

</details>

## Dependencies

- grep
Expand Down

0 comments on commit 235dd10

Please sign in to comment.