zigfetch/README.md

Zigfetch

• Description
• Requirements
• Installation
• Usage
  • Configuration
• Roadtrip
• Contributing

Description

Zigfetch is a minimal neofetch/fastfetch like system information tool

Requirements

• zig v0.14.0

Installation

# Clone the repo
$ git clone https://github.com/utox39/zigfetch.git

# cd to the path
$ cd path/to/zigfetch

# Build zigfetch
$ zig build -Doptimize=ReleaseSafe

# Then move it somewhere in your $PATH. Here is an example:
$ mv ./zig-out/zigfetch ~/bin/

Usage

$ 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

$ mkdir -p ~/.config/zigfetch

• Create the config file

$ cd ~/.config/zigfetch
$ touch config.json

• Or copy the default config (preferred way)

$ 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

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.