docs(README): update README
This commit is contained in:
76
README.md
76
README.md
@@ -13,13 +13,13 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
- [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
|
||||||
|
|
||||||
@@ -27,11 +27,11 @@ Zigfetch is a minimal [neofetch](https://github.com/dylanaraps/neofetch)/[fastfe
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- \>= [zig v0.15.2](https://ziglang.org/)
|
- \>= [zig v0.15.2](https://ziglang.org/)
|
||||||
|
|
||||||
### Linux only
|
### Linux only
|
||||||
|
|
||||||
- [libpci](https://github.com/pciutils/pciutils)
|
- [libpci](https://github.com/pciutils/pciutils)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -54,7 +54,7 @@ $ mv ./zig-out/zigfetch ~/bin/
|
|||||||
### Via [Homebrew](https://brew.sh/)
|
### Via [Homebrew](https://brew.sh/)
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ brew install utox39/tap/zigfetch
|
brew install utox39/tap/zigfetch
|
||||||
```
|
```
|
||||||
|
|
||||||
### Other package managers
|
### Other package managers
|
||||||
@@ -66,7 +66,7 @@ $ brew install utox39/tap/zigfetch
|
|||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ zigfetch
|
zigfetch
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
@@ -74,44 +74,44 @@ $ 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
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Modules
|
#### Modules
|
||||||
|
|
||||||
Available modules:
|
Available modules:
|
||||||
|
|
||||||
- Os
|
- Os
|
||||||
- Kernel
|
- Kernel
|
||||||
- Uptime
|
- Uptime
|
||||||
- Packages
|
- Packages
|
||||||
- Shell
|
- Shell
|
||||||
- Cpu
|
- Cpu
|
||||||
- Gpu
|
- Gpu
|
||||||
- Ram
|
- Ram
|
||||||
- Swap
|
- Swap
|
||||||
- Disk
|
- Disk
|
||||||
- Net
|
- Net
|
||||||
- WM (Window Manager)
|
- WM (Window Manager)
|
||||||
- Terminal
|
- Terminal
|
||||||
- Locale
|
- Locale
|
||||||
- Custom
|
- Custom
|
||||||
|
|
||||||
| Module type | Linux | macOS | Windows |
|
| Module type | Linux | macOS | Windows |
|
||||||
| :---------: | :-------------: | :----------------------: | :-----: |
|
| :---------: | :-------------: | :----------------------: | :-----: |
|
||||||
@@ -176,11 +176,11 @@ To change the Username and Hostname color (HEX colors only):
|
|||||||
|
|
||||||
## Roadtrip
|
## Roadtrip
|
||||||
|
|
||||||
- [ ] Add ASCII art for each operating system and Linux distro
|
- [ ] Add ASCII art for each operating system and Linux distro
|
||||||
- [x] Add GPU info for Linux
|
- [x] Add GPU info for Linux
|
||||||
- [ ] Add packages info for Linux
|
- [x] Add packages info for Linux
|
||||||
- [x] Add user customization
|
- [x] Add user customization
|
||||||
- [ ] Add support for Windows
|
- [ ] Add support for Windows
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user