bitua/zigfetch
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs(README): update README

Browse Source
This commit is contained in:
utox39
2025-07-12 01:56:02 +02:00
parent 707f94bd8b
commit 073d512b67
1 changed files with 21 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -1,12 +1,12 @@
# Zigfetch # Zigfetch
- [Description](#description) - [Description](#description)
- [Requirements](#requirements) - [Requirements](#requirements)
- [Installation](#installation) - [Installation](#installation)
- [Usage](#usage) - [Usage](#usage)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Roadtrip](#roadtrip) - [Roadtrip](#roadtrip)
- [Contributing](#contributing) - [Contributing](#contributing)
## Description ## Description
@@ -14,7 +14,11 @@ Zigfetch is a minimal [neofetch](https://github.com/dylanaraps/neofetch)/[fastfe
## Requirements ## Requirements
- [zig v0.14.0](https://ziglang.org/) - \>= [zig v0.14.0](https://ziglang.org/)
### Linux only
- [libpci](https://github.com/pciutils/pciutils) (linux only)
## Installation ## Installation
@@ -43,20 +47,20 @@ $ zigfetch
> [!IMPORTANT] > [!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](https://github.com/utox39/zigfetch/blob/main/config.json)) to avoid errors > 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](https://github.com/utox39/zigfetch/blob/main/config.json)) to avoid errors
- Create the config folder - Create the config folder
```console ```console
$ mkdir -p ~/.config/zigfetch $ mkdir -p ~/.config/zigfetch
``` ```
- Create the config file - Create the config file
```console ```console
$ cd ~/.config/zigfetch $ cd ~/.config/zigfetch
$ touch config.json $ touch config.json
``` ```
- Or copy the default config (preferred way) - Or copy the default config (preferred way)
```console ```console
$ cp /path/to/zigfetch/config.json ~/.config/zigfetch/config.json $ cp /path/to/zigfetch/config.json ~/.config/zigfetch/config.json
@@ -64,11 +68,12 @@ $ cp /path/to/zigfetch/config.json ~/.config/zigfetch/config.json
## Roadtrip ## Roadtrip
- [ ] Add ASCII art for each operating system and Linux distro - [ ] Add ASCII art for each operating system and Linux distro
- [ ] Add GPU info for Linux - [ ] Add GPU info for Linux
- [ ] Add packages info for Linux - [ ] Add packages info for Linux
- [x] Add user customization - [x] Add user customization
- [ ] Add support for Windows - [ ] Add support for Windows
## Contributing ## 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. If you would like to contribute to this project just create a pull request which I will try to review as soon as possible.