Update README.md

This commit is contained in:
Jakub Dorničák 2022-12-02 20:45:21 +01:00 committed by GitHub
parent 7bba6d115d
commit 2ccfc46594
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -11,3 +11,38 @@
<p align="center">
A cross-platform command-line interface (CLI) tool written in Rust</br> to display system information in an aesthetically pleasing and entertaining manner.
</p>
## ✨ Demo
`Ponyfetch` provides an aesthetically pleasing, colorful display of important system information, complete with charming ponies.
<img src="https://i.postimg.cc/MK6Fy3tP/konecne.gif" style="height: 300px; width: 570px;" alt="demo">
## ⚡ Installing
If you don't want to compile this tool by yourself, it's possible to just download current already prebuilt build [right here](https://github.com/Atsukoro1/ponyfetch/releases).
## 🔨 Compiling
Make sure you have [rust compiler and build tools](https://www.rust-lang.org/tools/install) installed.
I've made it easy for you, just cd into project folder and run this shell script.
- 🐧 On Linux
```sh
chmod +x ./install.sh && sudo ./install.sh
```
- 🖥️ On Windows
```sh
(WIP) Ponyfetch is still not available on Windows
```
- 🍎 On Mac
```sh
(WIP) Ponyfetch was never tested on Mac and it's stability can't be guaranteed.
```