mirror of
https://github.com/Atsukoro1/ponyfetch.git
synced 2024-11-27 06:17:59 +01:00
55 lines
2.2 KiB
Markdown
55 lines
2.2 KiB
Markdown
<div align="center">
|
|
<img
|
|
src="https://i.postimg.cc/bwmFtxyp/fd-1.png" style="height: 220px; width: 340px;"
|
|
/>
|
|
</div>
|
|
<p align="center">
|
|
<img src="https://img.shields.io/github/contributors/Atsukoro1/ponyfetch?color=blue&style=for-the-badge"/>
|
|
<img src="https://img.shields.io/github/issues/Atsukoro1/ponyfetch?style=for-the-badge"/>
|
|
<img src="https://img.shields.io/badge/Made%20with-Rust-blue?style=for-the-badge"/>
|
|
</p>
|
|
<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
|
|
|
|
```txt
|
|
(WIP) Ponyfetch is still not available on Windows
|
|
```
|
|
|
|
- 🍎 On Mac
|
|
|
|
```txt
|
|
(WIP) Ponyfetch was never tested on Mac and it's stability can't be guaranteed.
|
|
```
|
|
|
|
## 📚 Contributing
|
|
|
|
#### 🐎 Adding new ponies
|
|
If you wish to add new ponies to the project, please adhere to the following guidelines in order to maintain the project's structural integrity and functionality. The two main distinguishing features of these ponies are their size and style (e.g. Hat or Wings). Refer to the current pony ASCII art to determine the size of your new pony. If your pony is larger than the others, use the format `<ponyname>_large`. If the size is the same as an existing pony, find a visible difference between your pony and the current one, and name it `<ponyname>_<difference>_large`. If you still don't know, open an issue and discuss it with members of our team.
|
|
|
|
- 🖥️ Modifying & Adding code
|