docs(README): update README
This commit is contained in:
33
README.md
33
README.md
@@ -1 +1,34 @@
|
||||
# Zigfetch
|
||||
|
||||
## Description
|
||||
|
||||
Zigfetch is a minimal [neofetch](https://github.com/dylanaraps/neofetch)/[fastfetch](https://github.com/fastfetch-cli/fastfetch) like system information tool
|
||||
|
||||
## Requirements
|
||||
|
||||
- [zig v0.14.0](https://ziglang.org/)
|
||||
|
||||
## Installation
|
||||
|
||||
```console
|
||||
# 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 run
|
||||
|
||||
# Then move it somewhere in your $PATH. Here is an example:
|
||||
$ mv zigfetch ~/bin
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```console
|
||||
$ zigfetch
|
||||
```
|
||||
|
||||
## 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