โ ๏ธ (WIP) This project is not ready for any serious use right now. A cross-platform command-line interface (CLI) tool written in Rust to display system information in an aesthetically pleasing and entertaining manner.
## ๐ Table of contents - [๐ Table of contents](#-table-of-contents) - [โจ Demo](#-demo) - [๐ง Using](#-using) - [๐งช Requirements for install](#-requirements-for-install) - [โก Installing](#-installing) - [๐ฆ with Cargo](#-with-cargo) - [๐ฆ Manually](#-manually) - [๐ Contributing](#-contributing) - [๐ Adding new ponies](#-adding-new-ponies) - [๐ฅ๏ธ Modifying \& Adding code](#๏ธ-modifying--adding-code) - [โ๏ธ Sources](#๏ธ-sources) ## โจ Demo `Ponyfetch` provides an aesthetically pleasing, colorful display of important system information, complete with charming ponies.
## ๐ง Using
Example:
```bash
ponyfetch -c=blue -p=rainbowdash_large
```
| Option | Description | Type | Default | Required? |
|--------|----------------------------------------------------------|--------|---------|-----------|
| `-c` or `--color` | Defines what color to print pony and titles in | `String` | `blue` | No |
| `-p` or `--pony` | Pony to print | `String` | `rainbowdash` | No |
| `-h` or `--help` | Help menu in case you don't understand this one | | | No |
## ๐งช Requirements for install
On Linux (MAC not tested), install net-tools package using
```sh
sudo apt-get install net-tools
```
or
```sh
sudo pacman -S net-tools
```
## โก Installing
There are multiple possible ways to install Ponyfetch, however, there is still a way to compile it yourself. If you want, please proceed with reading Compiling section.
### ๐ฆ with Cargo
```sh
cargo install ponyfetch
```
### ๐ฆ Manually
To install the latest version of PonyFetch, first visit the available release [here](https://github.com/Atsukoro1/ponyfetch/releases) and download the executable. For Linux, move the binary to the /usr/bin directory. For Windows, move the binary to any desired path and add it to your system's PATH environment variable.
## ๐ 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 `