[+] Write readme
This commit is contained in:
parent
71fb76d4f7
commit
1ff2ea73ec
1 changed files with 32 additions and 0 deletions
32
README.md
32
README.md
|
@ -1,7 +1,39 @@
|
|||
# HyFetch
|
||||
|
||||
neofetch with pride flags <3
|
||||
|
||||

|
||||
|
||||
## Installation
|
||||
|
||||
Install Python >= 3.9 first. Then, just do:
|
||||
|
||||
```sh
|
||||
pip install hyfetch
|
||||
```
|
||||
|
||||
## 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!
|
||||
|
||||

|
||||
|
||||
## More Screenshots
|
||||
|
||||

|
||||
|
||||
<h3 align="center"><img src="https://i.imgur.com/ZQI2EYz.png" alt="logo" height="100px"></h3>
|
||||
|
|
Loading…
Add table
Reference in a new issue