Skip to content

Commit

Permalink
docs: simplify docs (#1273)
Browse files Browse the repository at this point in the history
  • Loading branch information
71zenith authored Feb 4, 2024
1 parent fde5470 commit 0a00507
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 16 deletions.
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ labels: 'priority 2: medium, type: bug'
assignees: ''

---
## **Make sure you are on the latest version by running `ani-cli -U`**

**Metadata (please complete the following information)**
Version: [e.g. 2.0.2]
Version: [e.g. 4.7.6, run `ani-cli -V` to find out]
OS: [e.g. Windows 10 / Linux Mint 20.3]
Shell: [e.g. zsh, run `readlink /bin/sh` to get your shell]
Anime: [e.g. flcl] (if applicable)
Expand All @@ -26,7 +27,7 @@ It says something about an unsupported protocol, see screenshot.
**Expected behavior**
Downloading should work

**Screenshots (if applicable; you can just drag the image onto github)**
**Screenshots (if applicable; you can just drag the image onto github. remove the following line if not needed)**
![image](https://user-images.githubusercontent.com/82055622/151030428-2e78d15f-4ba9-4d86-b6f3-8307557b4b29.png)

**Additional context**
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
- [ ] `-e` select episode works
- [ ] `-S` select index works
- [ ] `-r` range selection works
- [ ] `--skip` ani-skip works
- [ ] `--skip-title` ani-skip title argument works
- [ ] `--no-detach` no detach works
- [ ] `--dub` and regular (sub) mode both work
- [ ] all providers return links (not necessarily on a single anime, use debug mode to confirm)
---
Expand Down
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,17 @@ A cli to browse and watch anime (alone AND with friends). This tool scrapes the

## Fixing errors

If you encounter "Video url not found" or any breaking issue, then make sure you are on latest version by typing
`sudo ani-cli -U` to update on Linux, Mac and Android. On Windows, run gitbash as administrator then there type `ani-cli -U`.
If you encounter `No results found` (and are sure the prompt was correct) or any breaking issue, then make sure you are on **latest version** by typing
`sudo ani-cli -U` to update on Linux, Mac and Android. On Windows, run windows terminal preview and there type `ani-cli -U`.
If after this the issue persists then open an issue.

History has been reworked and relocated. We're working on a transition script, please be patient. Old history can be viewed with `less ${XDG_CACHE_HOME:-$HOME/.cache}/ani-hsts`

## Install

[![Packaging status](https://repology.org/badge/vertical-allrepos/ani-cli.svg?minversion=4.0)](https://repology.org/project/ani-cli/versions)

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

*These Plattforms have rock solid support and are used by maintainers and large parts of the userbase.*
*These Platforms have rock solid support and are used by maintainers and large parts of the userbase.*

<details><summary><b>Linux</b></summary>

Expand All @@ -68,7 +66,7 @@ History has been reworked and relocated. We're working on a transition script, p
*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>
<details><summary>Debian 13/unstable</summary>

```sh
sudo apt install ani-cli
Expand Down Expand Up @@ -164,23 +162,20 @@ For players you can use the apk (playstore/fdroid) versions of mpv and vlc. Note

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

*While officially supported, installation is more involved on these plattforms and sometimes issues arise. \
*While officially supported, installation is more involved on these platforms 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*

First, you'll need windows terminal preview. [(Install)](https://apps.microsoft.com/store/detail/windows-terminal-preview/9N8G5RFZ9XK3?hl=de-at&gl=at&rtc=1)

Then make sure git bash is installed. [(Install)](https://git-scm.com/download/win) It needs to be added to windows terminal [(Instructions)](https://stackoverflow.com/questions/56839307/adding-git-bash-to-the-new-windows-terminal)
First, you'll need windows terminal preview. [(Install)](https://apps.microsoft.com/store/detail/windows-terminal-preview/9N8G5RFZ9XK3?hl=en-us&gl=US) It comes preinstalled with Windows 11

The following steps and ani-cli need to be run from git bash in windows terminal.
Then, install scoop. You will use this to install and update ani-cli from time to time. [(Install)](https://scoop.sh/) Follow **quickstart**.

```sh
scoop bucket add extras
scoop install ani-cli
scoop install ani-cli fzf mpv git
```
Consider also installing `yt-dlp` and `aria2` for downloading to work

#### Dependencies

Expand Down

0 comments on commit 0a00507

Please sign in to comment.