ponysay/README.md
Erkin Batu Altunbaş cc0ddd7c74 Bunch of edits
* Make truncater rather readable and indented (hope you won't mind!)
* List people in CREDITS (ask to get your name removed or changed)
* Make README better
2012-05-12 19:57:55 +02:00

67 lines
2.3 KiB
Markdown

`ponysay` - A cowsay wrapper for ponies.
![Derp](http://i.imgur.com/xOJbE.png)
Today your terminal, tomorrow the world!
Installation on Linux (or other Unix)
-------------------------------------
First of all, you need `cowsay` from your local repositories.
Obtain it from [here](http://www.nog.net/~tony/warez/cowsay.shtml) if you wish to compile it yourself.
[Download](https://github.com/erkin/ponysay/downloads) or clone the project.
In the terminal, `cd` into the ponysay directory and `make install`.
This will install ponysay into the $PREFIX (`/usr` by default, meaning you may need to make as root).
In order to use ponysay, run:
ponysay "I am just the cutest pony!"
Or if you have a specific pony in your mind:
ponysay -f pinkie "Partay!~"
### Pony fortune on terminal startup
This requires that you have the `fortune` utility installed. You can install it from your repositories or just fetch the source code from [here](ftp://ftp.ibiblio.org/pub/linux/games/amusements/fortune/).
You can try [this](http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/) script to ponify fortunes.
Edit your `~/.bashrc` and add this to the end of the file
fortune | ponysay
Now every time you open a terminal a pony should give your fortune
### Ponies in TTY (Linux VT)
If you have a custom colour palette edit your `~/.bashrc` and add
if [ "$TERM" = "linux" ]; then
function ponysay
{
exec ponysay $@
#RESET PALETTE HERE
}
fi
Installation on Microsoft™ Windows®
-----------------------------------
[¯\\\_(ツ)\_/¯](http://i.imgur.com/2nP5N.png)
FAQ
---
__Q:__ The output looks like a mess in _(TTY/PuTTY/other)_!
__A:__ Unfortunately, there's nothing much we can do about it. See [issue 1](https://github.com/erkin/ponysay/issues/1).
__Q:__ You are missing _(my-favourite-pony)_!
__A:__ Ask and we'll add!
__Q:__ Which programs do you use to generate the pony files?
__A:__ The pony files are actually a bunch of selected [browser ponies](http://web.student.tuwien.ac.at/~e0427417/browser-ponies/ponies.html) that are generated into cow files via [img2xterm](https://github.com/rossy2401/img2xterm) or [util-say](https://github.com/maandree/util-say).