search

pystardust / ani-cli

A cli tool to browse and play anime
GNU General Public License v3.0
7.72k stars 539 forks source link

docs: prune and reorder homies #1080

Closed port19x closed 1 year ago

port19x commented 1 year ago

Pull Request Template

closes #1071

Type of change

Derisis13 commented 1 year ago

Since we're doing this, do we want to extract the massive list of installations/uninstallations into a separate installing.md that is hyperlinked in the readme? It would be an extra step for new users, for a more streamlined readme, but we're at the point where the readme is almost as large as the whole script (373 lines and 430 lines)

justchokingaround commented 1 year ago

another alternative would be for use to write a proper wiki page

port19x commented 1 year ago

another alternative would be for use to write a proper wiki page

I'm against using github wiki for this, since it's not version controllable

port19x commented 1 year ago

Since we're doing this, do we want to extract the massive list of installations/uninstallations into a separate installing.md that is hyperlinked in the readme? It would be an extra step for new users, for a more streamlined readme, but we're at the point where the readme is almost as large as the whole script (373 lines and 430 lines)

I'd prefer just omitting the sections listing native packages and how to install them, especially if they appear in the repology badge. I trust that especially linux users are capable of installing a program from their native package manager. We don't have to tell them to sudo apt install ani-cli

port19x commented 1 year ago

Anyway I believe this should be properly discussed in another issue that I'll open