PonyMirrors/ponysay
1
0
Fork 0
mirror of https://github.com/erkin/ponysay.git synced 2024-11-25 05:47:59 +01:00
Code Issues Projects Releases Packages Wiki Activity

Correct some mistakes, reword certain phrases

Browse source
This commit is contained in:
Erkin Batu Altunbaş 2013-05-17 17:59:07 +03:00
parent 9054dad2bd
commit 0747fab2e1
4 changed files with 45 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING
View file

@ -14,7 +14,7 @@ For a guide on this matter please refer to the info
The info manual is constantly updated, and will always The info manual is constantly updated, and will always
need to be reviewed. The info manual is written in need to be reviewed. The info manual is written in
ponified British "-ise" Longish, if this does not hold ponified British English, if this does not hold
for a section in the manual, or if it contains typos, for a section in the manual, or if it contains typos,
spellos, or can in general be better formulated. Please spellos, or can in general be better formulated. Please
send a patch or mention so in a commit comment. send a patch or mention so in a commit comment.
@ -30,8 +30,8 @@ Although translations of the primary manual (the PDF)
may not be piratically due to its constant updating, may not be piratically due to its constant updating,
translations of the man pages are useful if you translations of the man pages are useful if you
speak a language from where good understanding of speak a language from where good understanding of
English is not common at all ages, ortographic English is not common at all ages, orthographic
correction are apresiated too. correction are appreciated as well.
-- Make new magic spells and improve existing ones -- -- Make new magic spells and improve existing ones --
@ -41,7 +41,6 @@ itself, just make a pull request, their are much,
style-wise, to think about. However, please try to style-wise, to think about. However, please try to
document every new method, function and class in the document every new method, function and class in the
same manner is the already existing ones. Maintainability same manner is the already existing ones. Maintainability
is also important, try not to write obscure superoptimised is also important, try not to write obscure super-optimised
code, unless it is actually necessary; and comment code, unless it is actually necessary; and comment
code segment's when it seems appropriate. code segment's when it seems appropriate.

3
COPYING
View file

@ -1,4 +1,4 @@
Ponysay — Cowsay reimplemention for ponies Ponysay — Cowsay reimplemention for ponies, see LICENCE for the licence.
Copyright (C) 2012, 2013 Erkin Batu Altunbaş et al. Copyright (C) 2012, 2013 Erkin Batu Altunbaş et al.
@ -24,4 +24,3 @@ whether or not you may commercially redistribute an image make use
that line ‘FREE: yes’, is included inside the image between two ‘$$$’ that line ‘FREE: yes’, is included inside the image between two ‘$$$’
lines and the ‘FREE’ is and upper case and directly followed by lines and the ‘FREE’ is and upper case and directly followed by
the colon. the colon.

53
LICENSE → LICENCE
View file

@ -619,56 +619,3 @@ Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee. copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

78
README.md
View file

@ -10,38 +10,38 @@ Installation on GNU/Linux (or other Unix implementations)
[Download](/erkin/ponysay/downloads) or clone the project. [Download](/erkin/ponysay/downloads) or clone the project.
In the terminal, `cd` into the ponysay directory and `./setup.py --freedom=partial install` or `python3 setup.py --freedom=partial install`. In the terminal, `cd` into the ponysay directory and `./setup.py --freedom=partial install` or `python3 setup.py --freedom=partial install`.
You may need to be super user to run `./setup.py --freedom=partial install` without `--private`, on most systems this Superuser permissions might be required in order to run `./setup.py --freedom=partial install` without `--private`, on most systems this
can be achieved by running `sudo ./setup.py --freedom=partial install`. can be achieved by running `sudo ./setup.py --freedom=partial install`.
If you only want completely free ponies install use `--freedom=strict` instead of `--freedom=partial`. If installing only the completely free ponies is desired, `--freedom=strict` should be used instead of `--freedom=partial`.
For more information we have provided you with an extensive [manual in PDF](https://github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true). For additional information, an extensive [manual in PDF](https://github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true) is provided.
In order to use ponysay, run: In order to use ponysay, run:
ponysay "I am just the cutest pony!" ponysay "I am just the cutest pony!"
Or if you have a specific pony in your mind: Or if you have a specific pony in your mind:
ponysay -f pinkie "Partay!~" ponysay -f pinkie "Partay!~"
Run `info ponysay`, `man 6 ponysay` or `ponysay -h` for more information. Consult `info ponysay`, `man 6 ponysay` or `ponysay -h` for additional information.
A Spanish manual is available: `man -L es 6 ponysay`. A Spanish manual is also available: `man -L es 6 ponysay`.
#### Arch Linux #### Arch Linux
The package is in the official repositories as `community/ponysay`, there is also a git version named `ponysay-git` in AUR. The package is in the official repositories as `community/ponysay`. A Git version is also present, named `ponysay-git` in AUR.
#### Chakra #### Chakra
A git version of the package is available as `ponysay-git` in CCR, alongside a stable package as `ponysay`. A git version of the package is available as `ponysay-git` in CCR, alongside a stable package called `ponysay`.
#### Gentoo Linux #### Gentoo Linux
There is a package for Gentoo, to make installation and keeping it up to date easy. You can find it in [this overlay](https://github.com/etu/aidstu-overlay). The package is named `games-misc/ponysay`. There is a package for Gentoo, to make installation and updating simple. You can find it in [this overlay](https://github.com/etu/aidstu-overlay). The package is named `games-misc/ponysay`.
#### Debian GNU/Linux and Ubuntu #### Debian GNU/Linux and Ubuntu
The DEB file can be found in this PPA [here](https://launchpad.net/~vincent-c/+archive/ppa). The DEB file can be found on this PPA [here](https://launchpad.net/~vincent-c/+archive/ppa).
### Pony fortune on terminal startup ### Print a pony fortune upon terminal startup
This requires that you have the `fortune` utility installed. You can install it from your repositories (may be named `fortune-mod`) This requires the `fortune` utility to be installed. It can install be from the distribution's repositories (might be named `fortune-mod`).
or just fetch the source code from [here](ftp://ftp.ibiblio.org/pub/linux/games/amusements/fortune/). Alternatively, one can 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 or You can try [this](http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/) script or
[ponypipe](/maandree/ponypipe) to ponify fortunes. [ponypipe](/maandree/ponypipe) to ponify fortunes.
@ -50,26 +50,28 @@ Edit your `~/.bashrc` and add this to the end of the file
fortune | ponysay fortune | ponysay
Now every time you open a terminal a pony should give your fortune Afterwards, every time you open a terminal a pony should give you a fortune.
### Pony quotes ### Pony quotes
Running `ponysay --q` will give you a random pony saying one it its quote from MLP:FiM, or you can specify the pony: `ponysay -q pinkie`. Running `ponysay -q` will print a random pony saying one of its quotes from My Little Pony: Friendship is Magic. The pony can be specified: `ponysay -q pinkie`.
Just as with `-f`, `-q` can be used multiple time to to sepecify a set of ponies from which one will be selected randomly. Just as with `-f`, `-q` can be used multiple times to specify a set of ponies from which a single one will be selected randomly.
When running `ponysay -l` or `ponysay -L` the ponies which have quotes will be printed bold or bright (depending on terminal). When running `ponysay -l` or `ponysay -L` the ponies with quotes will be printed in bold or bright (depending on the used terminal).
### Ponies in TTY (Linux VT) ### Ponies in TTY (Unix VT)
If you have a custom colour palette edit your `~/.bashrc` and add If you have a custom colour palette edit your `~/.bashrc` and add
if [ "$TERM" = "linux" ]; then ```
function ponysay if [ "$TERM" = "linux" ]; then
{ function ponysay
exec ponysay "$@" {
#RESET PALETTE HERE exec ponysay "$@"
} #RESET PALETTE HERE
fi }
fi
```
Read the PDF or info manual for more information. Read the PDF or info manual for more information.
@ -82,19 +84,19 @@ Installation on Microsoft™ Windows®
Dependencies Dependencies
------------ ------------
### Required runtime dependencies ### Runtime dependencies
`coreutils`: `stty` in coreutils used to determine size of the terminal `coreutils`: `stty` in coreutils used to determine size of the terminal.
`python>=3`: written in python 3 `python>=3`: `ponysay` is written in Python 3.
### Package building dependencies ### Package building dependencies
`gzip`: used for compressing manuals (suppressable with `./configure --without-info-compression --without-man-compression`) `gzip`: Used for compressing manuals (suppressable with `./configure --without-info-compression --without-man-compression`).
`texinfo`: used for building info manual (suppressable with `./configure --without-info`) `texinfo`: Used for building the info manual (suppressable with `./configure --without-info`).
`python>=3`: the installation process is written in python 3 `python>=3`: The installation process is written in Python 3.
Run `./dependency-test.sh` if things are not working for you. Run `./dependency-test.sh` if things are not working for you.
@ -104,19 +106,19 @@ FAQ
__Q:__ The output looks like a mess in _(TTY/PuTTY/other)_! __Q:__ The output looks like a mess in _(TTY/PuTTY/other)_!
__A:__ Unfortunately we cannot make it perfect, see [issue 1](//github.com/erkin/ponysay/issues/1). But we have done a lot, read more about how to get the best the current state of the art has to offer in the [manual](//github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true). __A:__ Unfortunately we cannot make it perfect, see [issue 1](//github.com/erkin/ponysay/issues/1). But we have done a lot, read more about how to get the best of the current state of the art has to offer in the [manual](//github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true).
__Q:__ The output looks like a mess in _(xfce4-terminal/mate-terminal/xterm/[...])_ with _(this)_ font!
__A:__ We use blocks for printing the ponies, if the blocks are misaligned, or if you do not use a truly monospaced font with aligned blocks try another monospaced font, such as 'Fixed [...]' or 'Liberation Mono.'
__Q:__ You are missing _(my-favourite-pony)_! __Q:__ You are missing _(my-favourite-pony)_!
__A:__ [Ask](//github.com/erkin/ponysay/issues) and we'll add! __A:__ [Ask](//github.com/erkin/ponysay/issues) and we'll add!
__Q:__ The outpus look weird on my _(xfce4-terminal/mate-terminal/xterm)_ with _this_ font
__A:__ We use blocks for printing the ponies, if the blocks are misalignated or you not use a __real__ monospaced font with aligned blocks try another monospaced font like 'fixed [misc]' or 'Liberation Mono'.
__Q:__ Which programs do you use to generate the pony files? __Q:__ Which programs do you use to generate the pony files?
__A:__ The pony files are actually mostly a bunch of selected [browser ponies](//web.student.tuwien.ac.at/~e0427417/browser-ponies/ponies.html), converted using [util-say](//github.com/maandree/util-say), __A:__ The pony files are in fact mostly a bunch of selected [browser ponies](//web.student.tuwien.ac.at/~e0427417/browser-ponies/ponies.html), converted using [util-say](//github.com/maandree/util-say),
Other are taken from desktop ponies, and finally another are created specificaly for ponysay. Other are taken from desktop ponies, and the others are created specifically for ponysay.
The [PDF manual](//github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true) should answer most of your questions. The [PDF manual](//github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true) should answer most of your questions.