docs(README): update README
This commit is contained in:
37
README.md
37
README.md
@@ -1,12 +1,12 @@
|
||||
# Zigfetch
|
||||
|
||||
- [Description](#description)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Configuration](#configuration)
|
||||
- [Roadtrip](#roadtrip)
|
||||
- [Contributing](#contributing)
|
||||
- [Description](#description)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Configuration](#configuration)
|
||||
- [Roadtrip](#roadtrip)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## Description
|
||||
|
||||
@@ -14,7 +14,11 @@ Zigfetch is a minimal [neofetch](https://github.com/dylanaraps/neofetch)/[fastfe
|
||||
|
||||
## 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
|
||||
|
||||
@@ -43,20 +47,20 @@ $ zigfetch
|
||||
> [!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
|
||||
|
||||
- Create the config folder
|
||||
- Create the config folder
|
||||
|
||||
```console
|
||||
$ mkdir -p ~/.config/zigfetch
|
||||
```
|
||||
|
||||
- Create the config file
|
||||
- Create the config file
|
||||
|
||||
```console
|
||||
$ cd ~/.config/zigfetch
|
||||
$ touch config.json
|
||||
```
|
||||
|
||||
- Or copy the default config (preferred way)
|
||||
- Or copy the default config (preferred way)
|
||||
|
||||
```console
|
||||
$ 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
|
||||
|
||||
- [ ] Add ASCII art for each operating system and Linux distro
|
||||
- [ ] Add GPU info for Linux
|
||||
- [ ] Add packages info for Linux
|
||||
- [x] Add user customization
|
||||
- [ ] Add support for Windows
|
||||
- [ ] Add ASCII art for each operating system and Linux distro
|
||||
- [ ] Add GPU info for Linux
|
||||
- [ ] Add packages info for Linux
|
||||
- [x] Add user customization
|
||||
- [ ] Add support for Windows
|
||||
|
||||
## 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.
|
||||
|
||||
Reference in New Issue
Block a user