mirror of
https://gitlab.com/mattia.basaglia/ASCII-Pony.git
synced 2024-11-28 06:48:00 +01:00
Merge pull request #6 from shlomif/shlomif-correct-typos
Correct some typos.
This commit is contained in:
commit
cdf2a52d1d
1 changed files with 23 additions and 20 deletions
37
README
37
README
|
@ -6,14 +6,14 @@ ASCII art of some characters from My Little Pony: Friendship is magic.
|
||||||
Available Characters
|
Available Characters
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
* Twilight Sparkle (Both as unicorn and as alicorn)
|
* Twilight Sparkle (Both as a unicorn and as an alicorn)
|
||||||
* Rainbow Dash (Both with open and closed wing)
|
* Rainbow Dash (Both with open and with closed wings)
|
||||||
* Fluttershy
|
* Fluttershy
|
||||||
* Rairy
|
* Rarity
|
||||||
* Pinkie Pie
|
* Pinkie Pie
|
||||||
* Applejack (Both with and without hat)
|
* Applejack (Both with and without the hat)
|
||||||
* Derpy
|
* Derpy
|
||||||
* Trixie (Both with and without hat)
|
* Trixie (Both with and without the hat)
|
||||||
* Rose
|
* Rose
|
||||||
* Lyra Heartstrings
|
* Lyra Heartstrings
|
||||||
* DJ Pon3 (Both with and without shades)
|
* DJ Pon3 (Both with and without shades)
|
||||||
|
@ -27,25 +27,27 @@ System Pony
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
systempony is a script which shows a pony and system information.
|
systempony is a script which shows a pony and system information.
|
||||||
It can be installed system-wide with make install (PREFIX selects the directory).
|
It can be installed system-wide using "make install" (PREFIX selects the
|
||||||
Global config is found in $PREFIX/share/ascii-pony/systempony.conf,
|
target directory).
|
||||||
|
|
||||||
|
The global config is found in $PREFIX/share/ascii-pony/systempony.conf,
|
||||||
(or ./systempony.conf if not installed), user config is in ~/.systempony.
|
(or ./systempony.conf if not installed), user config is in ~/.systempony.
|
||||||
|
|
||||||
Config Variables:
|
Config Variables:
|
||||||
* PONY : pony identifier or "random",
|
* PONY : a pony identifier or "random",
|
||||||
see "./systempony --list" for a list of identifiers
|
see "./systempony --list" for a list of identifiers
|
||||||
* INFO : array of system info to display, "./systempony -h" for a list
|
* INFO : an array of system info to display, "./systempony -h" for a list
|
||||||
* FSTYPE : file system type used to calculate disk usage (Uses df),
|
* FSTYPE : a file system type used to calculate disk usage (Uses df),
|
||||||
if empty it will show the total.
|
if empty it will show the total.
|
||||||
|
|
||||||
Requirements:
|
Requirements:
|
||||||
* lsb-release for Dirstro
|
* lsb-release for Distro
|
||||||
* lxc for Containers
|
* lxc for Containers
|
||||||
|
|
||||||
Generating Images
|
Generating Images
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
Each final character is divided into separate file, one for each color.
|
Each final character is divided into a separate file, one for each color.
|
||||||
The file name is what you'd put in an ANSI escape to make it colored.
|
The file name is what you'd put in an ANSI escape to make it colored.
|
||||||
The script render_parts.php takes a directory as input and scans for such files.
|
The script render_parts.php takes a directory as input and scans for such files.
|
||||||
It produces the following kinds of output:
|
It produces the following kinds of output:
|
||||||
|
@ -54,11 +56,12 @@ It produces the following kinds of output:
|
||||||
* Plaintext (if you pass nocolor)
|
* Plaintext (if you pass nocolor)
|
||||||
* SVG (if you pass svg)
|
* SVG (if you pass svg)
|
||||||
|
|
||||||
Being a PHP script it requires PHP in order to run it.
|
Being a PHP script, it requires PHP in order to run.
|
||||||
|
|
||||||
The makefile will compile all of the above, the plaintext in the same directory
|
The makefile will compile all of the above, the plaintext in the same directory
|
||||||
as the parent of the directory containing the various part files, everything else
|
as the parent of the directory containing the various part files,
|
||||||
in /rendered.
|
and everything else in /rendered.
|
||||||
|
|
||||||
It will also call Inkscape to generate PNG images from the SVG.
|
It will also call Inkscape to generate PNG images from the SVG.
|
||||||
|
|
||||||
You can cat the colored files on a terminal to see the fancy output (as long as
|
You can cat the colored files on a terminal to see the fancy output (as long as
|
||||||
|
@ -72,5 +75,5 @@ License
|
||||||
|
|
||||||
Dual:
|
Dual:
|
||||||
|
|
||||||
* GPLv3+ http://www.gnu.org/licenses/gpl.html
|
* GPLv3+ : http://www.gnu.org/licenses/gpl.html
|
||||||
* CC-BY-SA 3.0 http://creativecommons.org/licenses/by-sa/3.0/
|
* CC-BY-SA 3.0 : http://creativecommons.org/licenses/by-sa/3.0/
|
||||||
|
|
Loading…
Reference in a new issue