Skip to content

Commit

Permalink
feat: new install process (#431)
Browse files Browse the repository at this point in the history
* docs: adjust default enhancement priority

* Split Mac and Linux

* Introduce Table of Contents

* Disclaimer linked in table of contents

* Just copy pasta the makefile

* Gave governance responsibility back to pystardust

* Ordered PR Policies

* Ordered contribution guidelines

* Doc polish

* Move the contributors back to main thingy

* Credits 2.0

* polish again

* Delete the makefile :)

* bump the version

* Bump version again

* status update
  • Loading branch information
port19x authored Jan 27, 2022
1 parent 16fd9d0 commit 086fd0c
Show file tree
Hide file tree
Showing 6 changed files with 67 additions and 90 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Enhancement
about: Do you know a better way to do something?
title: ''
labels: 'priority 2: medium, type: enhancement'
labels: 'priority 3: low, type: enhancement'
assignees: ''

---
Expand Down
29 changes: 13 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-brightgreen.svg)](https://GitHub.com/pystardust/ani-cli/graphs/commit-activity)
[![Maintainer](https://img.shields.io/badge/maintainer-pystardust-blue)](https://github.com/pystardust)
[![Maintainer](https://img.shields.io/badge/maintainer-ura43-blue)](https://github.com/ura43)
[![Maintainer](https://img.shields.io/badge/maintainer-RayGL-blue)](https://github.com/RaynardGerraldo)
[![Maintainer](https://img.shields.io/badge/maintainer-Dink4n-blue)](https://github.com/Dink4n)
[![Maintainer](https://img.shields.io/badge/maintainer-CoolnsX-blue)](https://github.com/CoolnsX)
[![Maintainer](https://img.shields.io/badge/maintainer-Derisis13-blue)](https://github.com/Derisis13)

# Contribution Guidelines

## Pull Requests

- Appease the linter
- Don't echo-pipe into another command
- Adjust the Readme according to your changes (if applicable)
- Indent with tabs and clear trailing white space before commits.
- Bump the version
- Try using built-in output functions (err, inf, prompt, `menu_line_*` and die) instead of echo and printf
- Try using shell builtins over external commands
- Avoid extra dependencies
### Rules

1. Appease the linter
2. Bump the version
3. Adjust the Readme according to your changes (if applicable)
4. No extra dependencies unless absolutely necessary

### Guidelines

5. Try using built-in output functions (err, inf, prompt, `menu_line_*` and die) instead of echo and printf
6. Don't echo-pipe into another command if avoidable
7. Indent with tabs
8. Try using shell builtins over external commands

## Testing

Expand Down
56 changes: 0 additions & 56 deletions Makefile

This file was deleted.

66 changes: 51 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align=center>
<img src="https://capsule-render.vercel.app/api?type=soft&fontColor=e5ab3e&text=pystardust/ani-cli&height=150&fontSize=60&desc=now%20sponsoring%20shellcheck&descAlignY=75&descAlign=60&color=00000000&animation=twinkling">
<img src="https://capsule-render.vercel.app/api?type=soft&fontColor=e5ab3e&text=pystardust/ani-cli&height=150&fontSize=60&desc=good%20riddance%20Makefile&descAlignY=75&descAlign=60&color=00000000&animation=twinkling">
<br>
<a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"></a>
<img src="https://img.shields.io/badge/os-linux-brightgreen">
Expand All @@ -8,10 +8,26 @@
<img src="https://img.shields.io/badge/os-android-brightgreen"></a>
<br>
<a href="https://discord.gg/aqu7GpqVmR"><img src="https://invidget.switchblade.xyz/aqu7GpqVmR"></a>
<br>
<a href="https://github.com/ura43"><img src="https://img.shields.io/badge/lead-ura43-lightblue"></a>
<a href="https://github.com/CoolnsX"><img src="https://img.shields.io/badge/maintainer-CoolnsX-blue"></a>
<a href="https://github.com/RaynardGerraldo"><img src="https://img.shields.io/badge/maintainer-RayGL-blue"></a>
<a href="https://github.com/Derisis13"><img src="https://img.shields.io/badge/maintainer-Derisis13-blue"></a>
</p>

A cli to browse and watch anime. This tool scrapes the site [gogoanime](https://gogoanime.pe).

## Table of Contents
- [Usage](#Usage)
- [Dependencies](#Dependencies)
- [Installation](#Installation)
- [Linux](#Linux)
- [Mac](#Mac)
- [Android/Termux](#Android/Termux)
- [Windows](#Windows)
- [Contribution Guidelines](./CONTRIBUTING.md)
- [Disclaimer](./disclaimer.md)

## Usage

```text
Expand Down Expand Up @@ -64,39 +80,59 @@ patch - Update checking

## Install

### Linux / Mac
### Linux

#### Arch Linux

```sh
yay -s ani-cli-git
```

#### Other

```sh
git clone https://github.com/pystardust/ani-cli
cd ani-cli
sudo make
sudo cp ani-cli /usr/local/bin/ani-cli
sudo +x /usr/local/bin/ani-cli
```

### Android (Termux)
### Mac

```sh
apt update
apt install git make ncurses-utils openssl-tool -y
git clone https://github.com/pystardust/ani-cli
cd ani-cli
make
cp ani-cli /usr/local/bin/ani-cli
chmod +x /usr/local/bin/ani-cli
```

### Android/Termux

```sh
pkg update
pkg install git make ncurses-utils openssl-tool -y
git clone https://github.com/pystardust/ani-cli
cd ani-cli
cp ani-cli /data/data/com.termux/files/home/bin/ani-cli
chmod +x /data/data/com.termux/files/home/bin/ani-cli
echo 'am start --user 0 -a android.intent.action.VIEW -d "$$3" -e "http-header-fields" "$$2" -n is.xyz.mpv/.MPVActivity' > /data/data/com.termux/files/home/bin/bin/mpv
chmod +x /data/data/com.termux/files/home/bin/bin/mpv
```

### Windows

* Download and install dependencies as mentioned above
* If you choose vlc, add it to path [Guide](https://www.vlchelp.com/add-vlc-command-prompt-windows)
* Download and install [gitbash](https://git-scm.com/downloads)
* Download and install [dependencies](#Dependencies)
* If you choose vlc, add it to path ([Guide](https://www.vlchelp.com/add-vlc-command-prompt-windows))
* Download and install [git bash](https://git-scm.com/downloads)
* Open git bash by right-clicking and choosing "Run as administrator"
* Run the following commands

```sh
git clone https://github.com/pystardust/ani-cli.git
cd ani-cli
make
mkdir -p "$(USERPROFILE)/.cache"
cp ani-cli $(WINDIR)/system32/ani-cli
```

## Disclaimer

The disclaimer of this project can be found [here](./disclaimer.md)

## Uninstall
Just remove the thing from path lul
2 changes: 1 addition & 1 deletion ani-cli
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/sh

# version number
VERSION="1.4.7"
VERSION="1.5.0"


# history file path
Expand Down
2 changes: 1 addition & 1 deletion disclaimer.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ Contacting the maintainer
</h3>
<br>

Begin by making a GitHub issue or sending an email to [email protected].
Begin by making a GitHub issue or sending an email to [email protected]
</div>

0 comments on commit 086fd0c

Please sign in to comment.