hyfetch/README.md

111 lines
4.3 KiB
Markdown
Raw Normal View History

2022-04-10 04:49:20 -06:00
# HyFetch
2022-04-10 05:15:52 -06:00
neofetch with pride flags <3
2022-04-10 04:49:20 -06:00
![image](https://user-images.githubusercontent.com/22280294/162614541-af2b4660-f1f7-4287-b978-1aa2266ac70f.png)
2022-04-10 05:15:52 -06:00
## Installation
2022-04-15 22:45:15 -06:00
### Method 1: Install using Python pip (Recommended)
2022-04-10 20:58:43 -06:00
Install Python >= 3.7 first. Then, just do:
2022-04-10 05:15:52 -06:00
```sh
pip install hyfetch
```
2022-04-15 22:45:15 -06:00
### Method 2: Install using system package manager
Currently, these distributions have existing packages for HyFetch:
* ArchLinux: `yay -S hyfetch` (Thanks to @ Aleksana)
* Guix: [In progress](https://issues.guix.gnu.org/54847#8-lineno27)
2022-04-10 05:15:52 -06:00
## Usage
When you run `hyfetch` for the first time, it will prompt you to choose a color system and a preset. Just follow the prompt, and everything should work (hopefully). If something doesn't work, feel free to submit an issue!
#### Q: How do I change my config?
A: Use `hyfetch -c`
#### Q: What do I do if the color is too dark/light for my theme?
A: You can try setting the colors' "lightness" using the `--c-set-l` parameter. The value should be between 0 and 1. For example, if you are using dark theme and the rainbow flag is too dark to display, you can type:
```sh
hyfetch -p rainbow --c-set-l 0.8
```
Feel free to experiment with it!
2022-04-10 04:49:20 -06:00
![image](https://user-images.githubusercontent.com/22280294/162614553-eb758e4e-1936-472c-8ca7-b601c696c6eb.png)
2022-04-10 05:15:52 -06:00
2022-04-10 20:58:43 -06:00
## Change Log
2022-04-10 21:50:13 -06:00
### TODO
* [ ] Add interactive configurator for adjusting brightness
* [ ] Add configuration to emphasize certain parts of the original ASCII art (to make icons like Fedora and Ubuntu look nicer)
2022-04-25 12:06:51 -06:00
### 1.0.6
* Remove `hypy_utils` dependency to make packaging easier.
2022-04-25 01:22:54 -06:00
### 1.0.5
* Fix terminal emulator detection ([PR #2](https://github.com/hykilpikonna/hyfetch/pull/2))
2022-04-14 17:34:48 -06:00
### 1.0.4
2022-04-14 17:35:58 -06:00
* Add more flags ([PR #1](https://github.com/hykilpikonna/hyfetch/pull/1))
2022-04-14 17:34:48 -06:00
### 1.0.3
* Fix missing dependency for setuptools
2022-04-10 20:58:43 -06:00
### 1.0.2
* Implement RGB to 8bit conversion
* Add support for Python 3.7 and 3.8
### 1.0.1
* Included 11 flag presets
* Ability to lighten colors with `--c-set-l <lightness>`
* Command-line flag chooser
* Supports Python >= 3.9
2022-04-10 05:15:52 -06:00
## More Screenshots
2022-04-10 04:49:51 -06:00
![image](https://user-images.githubusercontent.com/22280294/162614578-3b878abb-2a32-4427-997e-f90b3f5cfd7c.png)
2022-04-10 21:43:11 -06:00
![image](https://user-images.githubusercontent.com/22280294/162661621-f1c61338-7857-4d3f-9fe3-c6b635d68c38.png)
## Original Readme from Neofetch Below
2022-04-10 04:49:20 -06:00
2018-05-23 16:52:55 -06:00
<h3 align="center"><img src="https://i.imgur.com/ZQI2EYz.png" alt="logo" height="100px"></h3>
2018-05-22 03:44:14 -06:00
<p align="center">A command-line system information tool written in bash 3.2+</p>
2018-05-16 20:36:03 -06:00
<p align="center">
<a href="./LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
<a href="https://github.com/dylanaraps/neofetch/releases"><img src="https://img.shields.io/github/release/dylanaraps/neofetch.svg"></a>
2018-06-20 21:55:44 -06:00
<a href="https://repology.org/metapackage/neofetch"><img src="https://repology.org/badge/tiny-repos/neofetch.svg" alt="Packaging status"></a>
2018-05-16 20:36:03 -06:00
</p>
2016-02-14 06:04:55 -07:00
2018-05-23 16:52:55 -06:00
<img src="https://i.imgur.com/GFmC5Ad.png" alt="neofetch" align="right" height="240px">
2018-05-16 21:06:53 -06:00
2018-04-15 16:28:01 -06:00
Neofetch is a command-line system information tool written in `bash 3.2+`. Neofetch displays information about your operating system, software and hardware in an aesthetic and visually pleasing way.
2018-01-02 17:37:03 -07:00
2018-04-15 16:38:22 -06:00
The overall purpose of Neofetch is to be used in screen-shots of your system. Neofetch shows the information other people want to see. There are other tools available for proper system statistic/diagnostics.
2018-04-15 16:28:01 -06:00
The information by default is displayed alongside your operating system's logo. You can further configure Neofetch to instead use an image, a custom ASCII file, your wallpaper or nothing at all.
2015-12-30 03:18:17 -07:00
2018-05-23 16:52:55 -06:00
<img src="https://i.imgur.com/lUrkQBN.png" alt="neofetch" align="right" height="240px">
2018-04-15 16:28:01 -06:00
You can further configure Neofetch to display exactly what you want it to. Through the use of command-line flags and the configuration file you can change existing information outputs or add your own custom ones.
2016-04-24 04:45:50 -06:00
2018-05-23 16:52:55 -06:00
Neofetch supports almost 150 different operating systems. From Linux to Windows, all the way to more obscure operating systems like Minix, AIX and Haiku. If your favourite operating system is unsupported: Open up an issue and support will be added.
2015-12-30 03:18:17 -07:00
2018-04-30 00:16:08 -06:00
2018-05-23 16:52:55 -06:00
### More: \[[Dependencies](https://github.com/dylanaraps/neofetch/wiki/Dependencies)\] \[[Installation](https://github.com/dylanaraps/neofetch/wiki/Installation)\] \[[Wiki](https://github.com/dylanaraps/neofetch/wiki)\]