2021-03-05 10:49:09 +01:00
# UwUFetch
2021-01-18 21:19:20 +01:00
2021-06-09 17:16:36 +02:00
A meme system info tool for (almost) all your Linux/Unix-based systems, based on the nyan/UwU trend on r/linuxmasterrace.
2021-01-18 21:19:20 +01:00
## Currently supported distros
2021-04-15 09:28:57 +02:00
2021-06-09 17:16:36 +02:00
### Full support (Both ASCII art + images are provided for the given distribution)
2021-04-15 09:28:57 +02:00
2021-08-27 21:17:33 +02:00
Nyalpine, Nyarch Linuwu, Nyartix Linuwu, Debinyan, endevaOwO, Fedowa, GentOwO, GnUwU gUwUix, Miwint, Myanjawo, OwOpenSUSE, Pop OwOs, RaspNyan, Swackwawe, sOwOlus, UwUntu, and OwOid; Plus Nyandroid.
2021-01-18 21:19:20 +01:00
2021-06-09 17:16:36 +02:00
### Partial support (Either no ASCII art, or no image is provided)
2021-04-15 09:28:57 +02:00
2021-05-07 21:10:31 +02:00
KDE NeOwOn, nixOwOs; Plus FweeBSD, OwOpenBSD and macOwOS; Plus WinyandOwOws.
2021-01-18 21:19:20 +01:00
## Building and installation
2021-06-09 17:16:36 +02:00
### Requisites
2021-03-16 09:10:54 +01:00
2021-08-28 14:19:56 +02:00
- [freecolor ](http://www.rkeene.org/oss/freecolor/ ) to get ram usage on FreeBSD.
2021-03-16 09:13:29 +01:00
2021-08-28 14:19:56 +02:00
- [viu ](https://github.com/atanunq/viu ) (optional) to use images instead of ascii art (see [How to use images ](#how-to-use-images ) below).
2021-03-16 09:10:54 +01:00
2021-08-28 14:19:56 +02:00
- [lshw ](https://github.com/lyonel/lshw ) (optional) for better accuracy on GPU info.
2021-07-24 12:44:54 +02:00
2021-06-09 17:16:36 +02:00
### Via package manager
2021-03-07 22:44:51 +01:00
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-13 21:37:27 +01:00
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
2021-06-09 17:16:36 +02:00
### From source
2021-03-07 22:44:51 +01:00
2021-06-09 17:16:36 +02:00
Build requisites:
2021-04-15 09:28:57 +02:00
2021-06-09 17:16:36 +02:00
- Make
- A C compiler
2021-04-12 13:16:45 +02:00
2021-03-09 06:00:41 +01: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
2021-03-13 21:37:27 +01:00
make build
2021-06-09 17:16:36 +02:00
sudo make install # for termux, use `make termux`
2021-01-18 21:19:20 +01:00
```
2021-03-06 21:17:29 +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
2021-03-13 21:37:27 +01:00
sudo make uninstall
2021-01-18 21:19:20 +01:00
```
2021-03-07 22:44:51 +01:00
2021-06-09 17:16:36 +02:00
#### Available Make targets
2021-03-07 22:44:51 +01:00
```shell
2021-04-28 02:25:55 +02:00
make build # builds uwufetch
2021-03-07 22:44:51 +01:00
make debug # use for debug
2021-03-13 21:37:27 +01:00
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
```
2021-04-02 15:56:57 +02:00
## Images and copyright info
2021-03-07 16:59:26 +01:00
2021-04-02 17:46:58 +02:00
### How to use images
2021-04-15 09:28:57 +02:00
2021-06-09 17:16:36 +02:00
First of all, you will need `viu` , which you can install by following the [guide ](https://github.com/atanunq/viu#installation ).
`viu` supports [kitty ](https://github.com/kovidgoyal/kitty ) and [iTerm ](https://iterm2.com/ )'s image protocols.
If not supported by the current terminal, `viu` uses the fallback Unicode half-block mode (images will look "blocky"), that is the case in many terminal emulators (gnome-terminal, Konsole, etc.). See also: [viu's README ](https://github.com/atanunq/viu#description ).
2021-01-18 21:19:20 +01:00
2021-04-02 17:46:58 +02:00
### For copyright and logos info
2021-04-15 09:28:57 +02:00
2021-08-28 14:19:56 +02:00
See [COPYRIGHT.md ](/res/COPYRIGHT.md ).
2021-04-02 15:56:57 +02:00
2021-01-18 21:19:20 +01:00
## License
2021-03-07 22:44:51 +01:00
2021-08-28 14:19:56 +02:00
This program is provided under the [GPL-3.0 License ](/LICENSE ).
2021-04-07 17:43:00 +02:00
2021-06-09 17:16:36 +02:00
## Contributing
2021-04-07 17:43:00 +02:00
2021-08-28 14:19:56 +02:00
All kinds of contributions are welcome, but before contributing please read [CONTRIBUTING.md ](/CONTRIBUTING.md ).