PonyMirrors/ponyfetch
1
0
Fork 0
mirror of https://github.com/Atsukoro1/ponyfetch.git synced 2024-11-27 06:17:59 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Jakub Dorničák 2022-12-02 21:09:08 +01:00 committed by GitHub
parent 98fe2a1831
commit f9bfb32f36
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -23,6 +23,8 @@
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).
After downloading the executable/binary files from releases, please install the install.sh file (for Linux/Mac) or install.bat file (for Windows) and proceed with the script part in the "Compiling" section.
## 🔨 Compiling
Make sure you have [rust compiler and build tools](https://www.rust-lang.org/tools/install) installed.
@ -50,6 +52,11 @@ chmod +x ./install.sh && sudo ./install.sh
## 📚 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.
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 are still unsure, please open an issue to discuss it with members of our team. Additionally, after adding a new pony, please ensure to credit the author in the "Sources" section of the README.
- 🖥️ Modifying & Adding code
#### 🖥️ Modifying & Adding code
Ponyfetch is still under development, so it is likely that there are bugs present. If you encounter one, please open an issue and discuss it with us. Once the discussion is completed, submit a pull request with the proposed changes.
## ⛓️ Sources
1. PYTHON, Clive. In: ASCIIMAN [online]. [cit. 2022-12-02]. Available from: https://asciiman.neocities.org/MLP.html
2. My Little Pony ASCII Art. [online]. [cited 2022-12-02]. Available from: https://emojicombos.com/my-little-pony-ascii-art