docs(README): update README

This commit is contained in:
utox39
2025-05-28 17:39:19 +02:00
parent d497f2e4b5
commit 801d15afc8

View File

@@ -1,5 +1,13 @@
# Zigfetch
- [Description](#description)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Roadtrip](#roadtrip)
- [Contributing](#contributing)
## Description
Zigfetch is a minimal [neofetch](https://github.com/dylanaraps/neofetch)/[fastfetch](https://github.com/fastfetch-cli/fastfetch) like system information tool
@@ -21,7 +29,7 @@ $ cd path/to/zigfetch
$ zig build -Doptimize=ReleaseSafe
# Then move it somewhere in your $PATH. Here is an example:
$ mv ./zig-out/zigfetch ~/bin
$ mv ./zig-out/zigfetch ~/bin/
```
## Usage
@@ -30,12 +38,36 @@ $ mv ./zig-out/zigfetch ~/bin
$ zigfetch
```
### Configuration
> [!IMPORTANT]
> Currently, Zig does not have a built-in library for JSON validation via JSON schema, so it is very important to follow the pattern shown in the default configuration file ([config.json]()) to avoid errors
- Create the config folder
```console
$ mkdir -p ~/.config/zigfetch
```
- Create the config file
```console
$ cd ~/.config/zigfetch
$ touch config.json
```
- Or copy the default config (preferred way)
```console
$ cp /path/to/zigfetch/config.json ~/.config/zigfetch/config.json
```
## Roadtrip
- [ ] Add ASCII art for each operating system and Linux distro
- [ ] Add GPU info for Linux
- [ ] Add packages info for Linux
- [ ] Add user customization
- [x] Add user customization
## Contributing
If you would like to contribute to this project just create a pull request which I will try to review as soon as possible.