Skip to content

Point to up to date fork #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Point to up to date fork #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 1 addition & 63 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,63 +1 @@
<p><img alt="Video of the Nyan Cat result printer for PHPUnit" src="https://github.com/whatthejeff/nyancat-phpunit-resultprinter/raw/master/nyan.gif"></p>

## Requirements

The Nyan Cat result printer for PHPUnit requires:

* PHP 7+.
* PHPUnit 6+.
* A terminal emulator with support for ANSI escape sequences, including color
and cursor control.

Use version `^1.3` to support PHPUnit 4.8+ / 5+.

**NOTE:** By default, the Windows console does not support ANSI escape
sequences. If you'd like to use the Nyan Cat result printer on Windows, you
may want to try one of the following solutions:

* [ANSICON](https://github.com/adoxa/ansicon)
* [ConEmu](https://github.com/Maximus5/ConEmu)

## Installation

The recommended way to install the Nyan Cat result printer for PHPUnit is
[through composer](http://getcomposer.org). Just create a `composer.json` file
and run the `composer install` command to install it:

~~~json
{
"require-dev": {
"whatthejeff/nyancat-phpunit-resultprinter": "^2.0"
}
}
~~~

Once installed, add the following attributes to the `<phpunit>` element in your
`phpunit.xml` file:

printerFile="vendor/whatthejeff/nyancat-phpunit-resultprinter/src/NyanCat/PHPUnit/ResultPrinter.php"
printerClass="NyanCat\PHPUnit\ResultPrinter"

**NOTE:** If PHPUnit was not installed via composer, you also need to include
the composer autoloader. One easy way to do this is to add the following
attribute to the `<phpunit>` element in your `phpunit.xml` file:

bootstrap="vendor/autoload.php"

## Tests

[![Build Status](https://travis-ci.org/whatthejeff/nyancat-phpunit-resultprinter.png?branch=master)](https://travis-ci.org/whatthejeff/nyancat-phpunit-resultprinter)

To run the test suite, you need [composer](http://getcomposer.org).

$ composer install
$ composer test

## Acknowledgements

The Nyan Cat result printer for PHPUnit was __heavily__ inspired by the
glorious [mocha/nyan.js](https://github.com/visionmedia/mocha/blob/master/lib/reporters/nyan.js).

## License

The Nyan Cat result printer for PHPUnit is licensed under the [MIT license](LICENSE).
This version is no longer maintained. Please switch to [jeroen/nyancat-phpunit-resultprinter](https://github.com/JeroenDeDauw/nyancat-phpunit-resultprinter/) which has support for the most recent PHPUnit version.