diff --git a/README.md b/README.md index 5f199da..76b7a69 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,38 @@

A cross-platform command-line interface (CLI) tool written in Rust
to display system information in an aesthetically pleasing and entertaining manner.

+ +## ✨ Demo + +`Ponyfetch` provides an aesthetically pleasing, colorful display of important system information, complete with charming ponies. + +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. +```