mirror of
https://github.com/erkin/ponysay.git
synced 2025-02-11 23:36:44 +01:00
Swap out readme for one that explains the port
This commit is contained in:
K. Lange
parent
0fa2f49561
commit
f9f6669fdb
2 changed files with 161 additions and 153 deletions
157
README.md
157
README.md
|
|
@ -1,157 +1,8 @@
|
|||
`ponysay` — cowsay reimplemention for ponies.
|
||||
# Ponysay in Kuroko
|
||||
|
||||
_This is a port of ponysay to [Kuroko](https://kuroko-lang.github.io/)_
|
||||
This is a port of [ponysay](https://github.com/erkin/ponysay) to [Kuroko](https://kuroko-lang.github.io/).
|
||||
|
||||
|
||||
Kuroko is a dialect of Python with explicit variable declaration and block scoping. Kuroko's standard library is incomplete and not fully compatible with Python, so this port needed to work around various issues.
|
||||
|
||||
Today your terminal, tomorrow the world!
|
||||
This repository has been stripped of some extraneous files to make it more suitable for use a submodule in [PonyOS](https://github.com/klange/ponyos), so some files specific to, eg., Linux console usage, as well as build and packaging scripts for the Python version have been removed.
|
||||
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
### Runtime dependencies
|
||||
|
||||
`coreutils`: `stty` in coreutils used to determine size of the terminal.
|
||||
|
||||
`python>=3`: `ponysay` is written in Python 3.
|
||||
|
||||
`texinfo`: for generating documentation during the installation.
|
||||
|
||||
### Package building dependencies
|
||||
|
||||
`gzip`: Used for compressing manuals (suppressable with `./configure --without-info-compression --without-man-compression`).
|
||||
|
||||
`texinfo`: Used for building the info manual (suppressable with `./configure --without-info`).
|
||||
|
||||
`python>=3`: The installation process is written in Python 3.
|
||||
|
||||
Run `./dependency-test.sh` if things are not working for you.
|
||||
|
||||
|
||||
|
||||
Installation on GNU/Linux (or other Unix implementations)
|
||||
---------------------------------------------------------
|
||||
|
||||
[Download](https://github.com/erkin/ponysay/releases) 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`.
|
||||
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`.
|
||||
If installing only the completely free ponies is desired, `--freedom=strict` should be used instead of `--freedom=partial`.
|
||||
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:
|
||||
|
||||
ponysay "I am just the cutest pony!"
|
||||
|
||||
Or if you have a specific pony in your mind:
|
||||
|
||||
ponysay -f pinkie "Partay!~"
|
||||
|
||||
Consult `info ponysay`, `man 6 ponysay` or `ponysay -h` for additional information.
|
||||
Spanish and Turkish manuals are also available: `man -L es 6 ponysay` and `man -L tr 6 ponysay` respectively.
|
||||
|
||||
#### Arch Linux
|
||||
The package is in the official repositories as `community/ponysay`. A Git version is also present, named `ponysay-git` in AUR thanks to an upstream.
|
||||
|
||||
#### Chakra
|
||||
A git version of the package is available as `ponysay-git` in CCR, alongside a stable package called `ponysay` thanks to an upstream.
|
||||
|
||||
#### Debian GNU/Linux
|
||||
Debian packages thanks to 'vcheng' can be found [here](http://www.vcheng.org/ponysay/).
|
||||
|
||||
#### Docker
|
||||
Running ponysay on [Docker](https://hub.docker.com/r/mpepping/ponysay/) thanks to 'mpepping' is a easy as:
|
||||
|
||||
```
|
||||
docker run -ti --rm mpepping/ponysay --help
|
||||
docker run -ti --rm mpepping/ponysay -q
|
||||
docker run -ti --rm mpepping/ponysay "foo"
|
||||
```
|
||||
|
||||
#### Gentoo Linux
|
||||
The package is in the official Gentoo repository as [games-misc/ponysay](https://packages.gentoo.org/packages/games-misc/ponysay).
|
||||
|
||||
#### Mac OS X (OSX) (macOS)
|
||||
A `ponysay` [Homebrew](https://github.com/mxcl/homebrew) formula is available.
|
||||
|
||||
#### Microsoft™ Windows®
|
||||
[¯\\\_(ツ)\_/¯](http://fc05.deviantart.net/fs71/i/2011/266/d/e/shrugpony_firefly_by_imaplode-d4aqtvx.png)
|
||||
|
||||
You could either run ponysay on:
|
||||
|
||||
* Cygwin
|
||||
* [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/about) (more compatible)
|
||||
|
||||
Make sure you install the latest Windows updates to [enable true colour console support](https://blogs.msdn.microsoft.com/commandline/2016/09/22/24-bit-color-in-the-windows-console/), then follow the install instructions for Ubuntu in a bash console.
|
||||
|
||||
#### OpenSuSe 13.2 or OpenSuSe Factory
|
||||
The package is available in OpenSuSe 13.2 and Factory since 6th april 2014, if you want the individual rpm look [here](http://www.rpmfind.net/linux/rpm2html/search.php?query=ponysay).
|
||||
|
||||
#### Ubuntu
|
||||
There is a PPA available thanks to 'vincent-c', specifically for ponysay, containing packages for all currently supported Ubuntu releases [here](https://launchpad.net/~vincent-c/+archive/ponysay).
|
||||
|
||||
### Print a pony fortune upon terminal startup
|
||||
|
||||
This requires the `fortune` utility to be installed. It can install be from the distribution's repositories (might be named `fortune-mod`).
|
||||
Alternatively, one can just fetch the source code from [here](http://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
|
||||
[ponypipe](https://github.com/maandree/ponypipe) to ponify fortunes.
|
||||
|
||||
Edit your `~/.bashrc` and add this to the end of the file
|
||||
|
||||
fortune | ponysay
|
||||
|
||||
Afterwards, every time you open a terminal a pony should give you a fortune.
|
||||
|
||||
### Pony quotes
|
||||
|
||||
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 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 with quotes will be printed in bold or bright (depending on the used terminal).
|
||||
|
||||
### Ponies in TTY (Unix 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
|
||||
```
|
||||
|
||||
Read the PDF or info manual for more information.
|
||||
|
||||
FAQ
|
||||
---
|
||||
|
||||
__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 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)_!
|
||||
|
||||
__A:__ [Ask](//github.com/erkin/ponysay/issues) and we'll add!
|
||||
|
||||
__Q:__ Which programs do you use to generate the pony files?
|
||||
|
||||
__A:__ The pony files are in fact mostly a bunch of selected [browser ponies](//panzi.github.io/Browser-Ponies/), converted using [util-say](//github.com/maandree/util-say),
|
||||
Other are taken from desktop ponies, and the others are created specifically for ponysay.
|
||||
|
||||
__Q:__ This project look like abandoned...
|
||||
|
||||
__A:__ Well, most dev and contributors has moved to more time consuming tasks so our time has been reduced, but we accept most
|
||||
PR for bugfixs and ponies (correctly built) and we're still looking for bug fixes and ponies, so stay tuned for the next
|
||||
release or pushes on the repository.
|
||||
|
||||
The [PDF manual](//github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true) should answer most of your questions.
|
||||
|
|
|
|||
157
README.upstream.md
Normal file
157
README.upstream.md
Normal file
|
|
@ -0,0 +1,157 @@
|
|||
`ponysay` — cowsay reimplemention for ponies.
|
||||
|
||||
_This is a port of ponysay to [Kuroko](https://kuroko-lang.github.io/)_
|
||||
|
||||
|
||||
|
||||
Today your terminal, tomorrow the world!
|
||||
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
### Runtime dependencies
|
||||
|
||||
`coreutils`: `stty` in coreutils used to determine size of the terminal.
|
||||
|
||||
`python>=3`: `ponysay` is written in Python 3.
|
||||
|
||||
`texinfo`: for generating documentation during the installation.
|
||||
|
||||
### Package building dependencies
|
||||
|
||||
`gzip`: Used for compressing manuals (suppressable with `./configure --without-info-compression --without-man-compression`).
|
||||
|
||||
`texinfo`: Used for building the info manual (suppressable with `./configure --without-info`).
|
||||
|
||||
`python>=3`: The installation process is written in Python 3.
|
||||
|
||||
Run `./dependency-test.sh` if things are not working for you.
|
||||
|
||||
|
||||
|
||||
Installation on GNU/Linux (or other Unix implementations)
|
||||
---------------------------------------------------------
|
||||
|
||||
[Download](https://github.com/erkin/ponysay/releases) 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`.
|
||||
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`.
|
||||
If installing only the completely free ponies is desired, `--freedom=strict` should be used instead of `--freedom=partial`.
|
||||
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:
|
||||
|
||||
ponysay "I am just the cutest pony!"
|
||||
|
||||
Or if you have a specific pony in your mind:
|
||||
|
||||
ponysay -f pinkie "Partay!~"
|
||||
|
||||
Consult `info ponysay`, `man 6 ponysay` or `ponysay -h` for additional information.
|
||||
Spanish and Turkish manuals are also available: `man -L es 6 ponysay` and `man -L tr 6 ponysay` respectively.
|
||||
|
||||
#### Arch Linux
|
||||
The package is in the official repositories as `community/ponysay`. A Git version is also present, named `ponysay-git` in AUR thanks to an upstream.
|
||||
|
||||
#### Chakra
|
||||
A git version of the package is available as `ponysay-git` in CCR, alongside a stable package called `ponysay` thanks to an upstream.
|
||||
|
||||
#### Debian GNU/Linux
|
||||
Debian packages thanks to 'vcheng' can be found [here](http://www.vcheng.org/ponysay/).
|
||||
|
||||
#### Docker
|
||||
Running ponysay on [Docker](https://hub.docker.com/r/mpepping/ponysay/) thanks to 'mpepping' is a easy as:
|
||||
|
||||
```
|
||||
docker run -ti --rm mpepping/ponysay --help
|
||||
docker run -ti --rm mpepping/ponysay -q
|
||||
docker run -ti --rm mpepping/ponysay "foo"
|
||||
```
|
||||
|
||||
#### Gentoo Linux
|
||||
The package is in the official Gentoo repository as [games-misc/ponysay](https://packages.gentoo.org/packages/games-misc/ponysay).
|
||||
|
||||
#### Mac OS X (OSX) (macOS)
|
||||
A `ponysay` [Homebrew](https://github.com/mxcl/homebrew) formula is available.
|
||||
|
||||
#### Microsoft™ Windows®
|
||||
[¯\\\_(ツ)\_/¯](http://fc05.deviantart.net/fs71/i/2011/266/d/e/shrugpony_firefly_by_imaplode-d4aqtvx.png)
|
||||
|
||||
You could either run ponysay on:
|
||||
|
||||
* Cygwin
|
||||
* [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/about) (more compatible)
|
||||
|
||||
Make sure you install the latest Windows updates to [enable true colour console support](https://blogs.msdn.microsoft.com/commandline/2016/09/22/24-bit-color-in-the-windows-console/), then follow the install instructions for Ubuntu in a bash console.
|
||||
|
||||
#### OpenSuSe 13.2 or OpenSuSe Factory
|
||||
The package is available in OpenSuSe 13.2 and Factory since 6th april 2014, if you want the individual rpm look [here](http://www.rpmfind.net/linux/rpm2html/search.php?query=ponysay).
|
||||
|
||||
#### Ubuntu
|
||||
There is a PPA available thanks to 'vincent-c', specifically for ponysay, containing packages for all currently supported Ubuntu releases [here](https://launchpad.net/~vincent-c/+archive/ponysay).
|
||||
|
||||
### Print a pony fortune upon terminal startup
|
||||
|
||||
This requires the `fortune` utility to be installed. It can install be from the distribution's repositories (might be named `fortune-mod`).
|
||||
Alternatively, one can just fetch the source code from [here](http://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
|
||||
[ponypipe](https://github.com/maandree/ponypipe) to ponify fortunes.
|
||||
|
||||
Edit your `~/.bashrc` and add this to the end of the file
|
||||
|
||||
fortune | ponysay
|
||||
|
||||
Afterwards, every time you open a terminal a pony should give you a fortune.
|
||||
|
||||
### Pony quotes
|
||||
|
||||
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 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 with quotes will be printed in bold or bright (depending on the used terminal).
|
||||
|
||||
### Ponies in TTY (Unix 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
|
||||
```
|
||||
|
||||
Read the PDF or info manual for more information.
|
||||
|
||||
FAQ
|
||||
---
|
||||
|
||||
__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 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)_!
|
||||
|
||||
__A:__ [Ask](//github.com/erkin/ponysay/issues) and we'll add!
|
||||
|
||||
__Q:__ Which programs do you use to generate the pony files?
|
||||
|
||||
__A:__ The pony files are in fact mostly a bunch of selected [browser ponies](//panzi.github.io/Browser-Ponies/), converted using [util-say](//github.com/maandree/util-say),
|
||||
Other are taken from desktop ponies, and the others are created specifically for ponysay.
|
||||
|
||||
__Q:__ This project look like abandoned...
|
||||
|
||||
__A:__ Well, most dev and contributors has moved to more time consuming tasks so our time has been reduced, but we accept most
|
||||
PR for bugfixs and ponies (correctly built) and we're still looking for bug fixes and ponies, so stay tuned for the next
|
||||
release or pushes on the repository.
|
||||
|
||||
The [PDF manual](//github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true) should answer most of your questions.
|
||||
Loading…
Reference in a new issue