neowofetch/README.md

86 lines
2.6 KiB
Markdown
Raw Normal View History

2021-03-05 10:49:09 +01:00
# UwUFetch
2021-01-18 21:19:20 +01:00
A meme system info tool for (almost) all your Linux/Unix-based systems, based on nyan/UwU trend on r/linuxmasterrace.
2021-01-18 21:19:20 +01:00
## Currently supported distros
2021-03-19 22:54:35 +01:00
#### Full support (Both Ascii art + images are provided for the given distribution)
Nyalpine, Nyarch Linuwu, Nyartix Linuwu, Debinyan, endOwO, Fedowa, GentOwO, GnUwU gUwUix, Miwint, Myanjawo, OwOpenSUSE, Pop OwOs, RaspNyan, UwUntu, and OwOid; Plus Nyandroid.
2021-01-18 21:19:20 +01:00
2021-03-19 22:54:35 +01:00
#### Partial support (Either no Ascii art, or no image is provided)
KDE NeOwOn, nixOwOs, Swackwawe, sOwOlus; Plus FweeBSD, OwOpenBSD and macOwOS
2021-01-18 21:19:20 +01:00
## Building and installation
#### Requisites
[viu](https://github.com/atanunq/viu) to use images instead of ascii art.
2021-03-16 09:13:29 +01:00
[lshw](https://github.com/lyonel/lshw) to get gpu info.
2021-03-07 22:44:51 +01:00
##### Via package manager
2021-03-12 11:17:35 +01:00
Right now, the package is only available on the AUR:
[![uwufetch](https://img.shields.io/aur/version/uwufetch?color=1793d1&label=uwufetch&logo=arch-linux&style=for-the-badge)](https://aur.archlinux.org/packages/uwufetch/)
2021-03-12 11:17:35 +01:00
[![uwufetch-git](https://img.shields.io/aur/version/uwufetch-git?color=1793d1&label=uwufetch-git&logo=arch-linux&style=for-the-badge)](https://aur.archlinux.org/packages/uwufetch-git/)
2021-03-07 22:44:51 +01:00
##### Via source
2021-03-07 22:44:51 +01:00
2021-04-12 13:16:45 +02:00
Building requisites:
- Make
- A C compiler
- `pandoc` to compile man pages
2021-04-12 13:16:45 +02:00
To install UwUfetch from the source, type these commands in the terminal:
2021-03-07 22:44:51 +01:00
2021-01-18 21:19:20 +01:00
```shell
2021-03-05 10:49:09 +01:00
git clone https://github.com/TheDarkBug/uwufetch.git
cd uwufetch
make build
make man
sudo make install
2021-01-18 21:19:20 +01:00
```
To uninstall:
2021-03-07 22:44:51 +01:00
2021-01-18 21:19:20 +01:00
```shell
2021-03-05 10:49:09 +01:00
cd uwufetch
sudo make uninstall
2021-01-18 21:19:20 +01:00
```
2021-03-07 22:44:51 +01:00
##### Make options:
```shell
2021-04-28 02:25:55 +02:00
make build # builds uwufetch
make man # builds the manpage (requires pandoc)
2021-03-07 22:44:51 +01:00
make debug # use for debug
make install # installs uwufetch (needs root permissons)
make uninstall # uninstalls uwufetch (needs root permissons)
2021-03-07 22:44:51 +01:00
make termux # build and install for termux
make termux_uninstall # uninstall for termux
```
## Images and copyright info
### How to use images
First at all you need `viu`, to install it follow the [guide](https://github.com/atanunq/viu#installation).
Images are working in almost every terminal, for a better experience i recommend [kitty](https://github.com/kovidgoyal/kitty)
2021-01-18 21:19:20 +01:00
### For copyright and logos info
<font size=2>[COPYRIGHT.md](https://github.com/TheDarkBug/uwufetch/tree/main/res/COPYRIGHT.md)</font>
2021-01-18 21:19:20 +01:00
## License
2021-03-07 22:44:51 +01:00
2021-03-05 10:49:09 +01:00
This program is provided under the [GPL-3.0 License](https://github.com/TheDarkBug/uwufetch/LICENSE).
2021-04-07 17:43:00 +02:00
# Contributing
2021-04-10 17:57:50 +02:00
All kind of contribution are welcome, but before contributing please read [CONTRIBUTING.md](https://github.com/TheDarkBug/uwufetch/blob/main/CONTRIBUTING.md).