PrideFetch/README.md

71 lines
1.5 KiB
Markdown
Raw Normal View History

# pridefetch 🏳️‍⚧️
2022-04-20 17:48:59 +01:00
2022-04-20 17:57:19 +01:00
![pridefetch screenshot](https://file.coffee/u/J0dk4lIjU5Wmdu.png)<br>
2022-05-24 16:34:07 +01:00
Python fetch script for showing your favourite pride flags & system stats!<br>
2022-05-22 22:03:30 +01:00
Originally forked from [megabytesofrem/pridefetch](https://github.com/megabytesofrem/pridefetch).<br>
2020-08-26 02:04:10 +01:00
## Examples
2022-04-20 17:48:59 +01:00
2022-04-20 15:07:08 +01:00
#### Display a trans flag
2022-04-20 17:48:59 +01:00
2020-08-26 02:04:10 +01:00
`pridefetch -f trans`
2022-04-20 15:07:08 +01:00
#### Display either a trans or lesbian flag, with a 50/50 chance
2022-04-20 17:48:59 +01:00
`pridefetch -r trans,lesbian`
2020-08-26 02:04:10 +01:00
2022-04-20 15:07:08 +01:00
#### List all the available flags
2022-04-20 17:48:59 +01:00
2022-04-20 15:07:08 +01:00
`pridefetch -l`
2022-04-20 15:08:18 +01:00
#### Display help with pridefetch
2022-04-20 17:48:59 +01:00
2022-04-20 15:08:18 +01:00
`pridefetch -h`
2022-04-20 15:07:08 +01:00
## Quickstart
2022-04-20 17:48:59 +01:00
**Requirements:** `Python 3.7` or higher, `python-distro` and `python-psutil`
2022-04-20 15:07:08 +01:00
```bash
git clone https://github.com/SpyHoodle/pridefetch.git
2022-05-24 21:06:46 +01:00
cd pridefetch/src
python __main__.py
2022-04-20 15:07:08 +01:00
```
2022-05-22 20:43:47 +01:00
## Running on NixOS
#### If your system supports flakes
2022-05-24 21:07:40 +01:00
> ⚠ Note: This has only been tested on x86_64-linux; it may or may not work on your system.
2022-05-22 21:33:22 +01:00
You can run pridefetch straight away
2022-05-22 20:43:47 +01:00
```bash
2022-05-22 21:33:22 +01:00
nix run github:SpyHoodle/pridefetch
2022-05-22 20:43:47 +01:00
```
2022-05-24 16:34:07 +01:00
Or, install it and then run
2022-05-22 20:43:47 +01:00
2022-05-22 21:33:22 +01:00
```bash
2022-05-22 20:43:47 +01:00
nix profile install github:SpyHoodle/pridefetch
2022-05-22 21:33:22 +01:00
pridefetch
2022-05-22 20:43:47 +01:00
```
2022-05-24 16:34:07 +01:00
2022-05-27 14:35:02 +01:00
## Running on Arch Linux
2022-05-29 14:14:21 +01:00
From the AUR
2022-05-27 14:35:02 +01:00
```bash
git clone https://aur.archlinux.org/pridefetch.git
cd pridefetch
makepkg -si
```
Or, with your AUR helper
```bash
paru -S pridefetch
```
2022-05-24 16:57:11 +01:00
## Made with ❤️ and 🏳️‍⚧️
2022-05-24 21:06:46 +01:00
- Pridefetch is at an early stage, so may not work on all systems.
2022-05-24 16:57:11 +01:00
- Please report any issues or bugs on the Issues tab.
2022-05-24 21:06:46 +01:00
- Checkout our [contributing guidelines](https://github.com/SpyHoodle/pridefetch/blob/master/CONTRIBUTING.md) if you'd like to contribute.