Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 33 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,34 @@ This is a small tool built with fastfetch/neofetch, ffmpeg and chafa. It allows

## Installation

### Installation for Linux
**Quick Links Installation Guide For:**

Recommended Python version: 3.11 and later. If you use NixOS refer to [Installation for NixOS](#installation-for-nixos).
[Linux](#installation-for-linux-system) • [Windows](#installation-for-windows-winget-or-scoop) • [macOS](#installation-for-macos-homebrew)• [Manual](#manual-installation) • [Development](#developer-installation)

Run this in the terminal.
### Installation for Linux System
Recommended Python version: 3.11 and later.

#### Installation for Arch / Arch-based distros (Community maintained)

Anifetch is available in the AUR package [anifetch-cli](https://aur.archlinux.org/packages/anifetch-cli), maintained by @AmmarSyamil.

Install it from the terminal. For example, with Yay:
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you messed something up here, some part of the AUR installation section got lost and now the general linux installation guide is in the aur section.
Also the nixos section is gone as well.


```bash
yay -S anifetch-cli
```

After installation, run this to test if anifetch was installed correctly:

```bash
anifetch example.mp4
```
Please read our [User guide](#user-guide) for more info on how to use anifetch.

#### Installation for other Linux Distro.
If you use NixOS refer to Installation for [NixOS](#installation-for-nixos).

Install it from the terminal. For example, with Yay:

```bash
curl https://raw.githubusercontent.com/Notenlish/anifetch/refs/heads/main/install.sh | bash
Expand All @@ -22,10 +45,12 @@ After installation, run this to test if anifetch was installed correctly:
anifetch example.mp4
```


Please read our [User guide](#user-guide) for more info on how to use anifetch.

---


### Installation for Windows (Winget or Scoop)

Check whether you have winget installed by running `winget` in the windows terminal. If you dont have it, install it [here](https://github.com/microsoft/winget-cli/?tab=readme-ov-file#installing-the-client). If you want, you can use [Scoop](https://scoop.sh/) instead. Just replace the `winget` part with `scoop`.
Expand All @@ -45,7 +70,10 @@ After installing the necessary dependencies using winget/scoop, install anifetch
> [!WARNING]
> **Do not** install `anifetch` on pypi, it is not related with this project. Install `anifetch-cli`.

### Installation for MacOS with Homebrew
Please read our [Post installation](#post-installation) and [User guide](#user-guide) for more info on how to use anifetch.


### Installation for macOS (HomeBrew)

Install homebrew if you haven't installed it already by following the guide [here](https://brew.sh/).

Expand Down Expand Up @@ -172,7 +200,7 @@ After you've done these steps, rebuild your system.

---

### Developer Installation (for contributors):
### Developer Installation

```bash
git clone https://github.com/Notenlish/anifetch.git
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ keywords = [
"fastfetch",
"anifetch",
]
version = "1.0.2"
version = "1.0.3"
description = "Animated terminal fetch with video and audio support."
# If I put everyone here it messes with the "author" meta section.
authors = [{ name = "Notenlish", email = "notenlish@gmail.com" }]
Expand Down
Loading