Skip to content

Commit 0a00507

Browse files
authored
docs: simplify docs (#1273)
1 parent fde5470 commit 0a00507

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ labels: 'priority 2: medium, type: bug'
66
assignees: ''
77

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

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

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

3233
**Additional context**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
- [ ] `-e` select episode works
2525
- [ ] `-S` select index works
2626
- [ ] `-r` range selection works
27+
- [ ] `--skip` ani-skip works
28+
- [ ] `--skip-title` ani-skip title argument works
29+
- [ ] `--no-detach` no detach works
2730
- [ ] `--dub` and regular (sub) mode both work
2831
- [ ] all providers return links (not necessarily on a single anime, use debug mode to confirm)
2932
---

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,17 @@ A cli to browse and watch anime (alone AND with friends). This tool scrapes the
4747

4848
## Fixing errors
4949

50-
If you encounter "Video url not found" or any breaking issue, then make sure you are on latest version by typing
51-
`sudo ani-cli -U` to update on Linux, Mac and Android. On Windows, run gitbash as administrator then there type `ani-cli -U`.
50+
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
51+
`sudo ani-cli -U` to update on Linux, Mac and Android. On Windows, run windows terminal preview and there type `ani-cli -U`.
5252
If after this the issue persists then open an issue.
5353

54-
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`
55-
5654
## Install
5755

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

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

62-
*These Plattforms have rock solid support and are used by maintainers and large parts of the userbase.*
60+
*These Platforms have rock solid support and are used by maintainers and large parts of the userbase.*
6361

6462
<details><summary><b>Linux</b></summary>
6563

@@ -68,7 +66,7 @@ History has been reworked and relocated. We're working on a transition script, p
6866
*Native packages have a more robust update cycle, but sometimes they are slow to upgrade. \
6967
If the one for your platform is up-to-date we suggest going with it.*
7068

71-
<details><summary>Debian unstable</summary>
69+
<details><summary>Debian 13/unstable</summary>
7270

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

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

167-
*While officially supported, installation is more involved on these plattforms and sometimes issues arise. \
165+
*While officially supported, installation is more involved on these platforms and sometimes issues arise. \
168166
Reach out if you need help.*
169167

170168
<details><summary><b>Windows</b></summary>
171169

172-
*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*
173-
174-
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)
175-
176-
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)
170+
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
177171

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

180174
```sh
181175
scoop bucket add extras
182-
scoop install ani-cli
176+
scoop install ani-cli fzf mpv git
183177
```
178+
Consider also installing `yt-dlp` and `aria2` for downloading to work
184179

185180
#### Dependencies
186181

0 commit comments

Comments
 (0)