Skip to content

Commit 15770f6

Browse files
committed
Add contributor and readme md files
1 parent 3f34b9f commit 15770f6

File tree

2 files changed

+92
-0
lines changed

2 files changed

+92
-0
lines changed

CONTRIBUTORS.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributors list
2+
3+
**Claudio Giordano** - [clagiordano](https://github.com/clagiordano)

README.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# PHPUnit result printer
2+
3+
PHPUnit result printer is a custom phpunit result printer with pretty output and timings
4+
5+
## Getting Started
6+
7+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
8+
9+
### Prerequisites
10+
11+
What things you need to install the software and how to install them
12+
13+
- php >= 5.4
14+
- composer
15+
16+
### Installing
17+
18+
The recommended way to install phpunit-result-printer is through [Composer](https://getcomposer.org).
19+
20+
```bash
21+
composer require clagiordano/phpunit-result-printer
22+
```
23+
24+
After install you can edit your phpunit.xml as follow:
25+
26+
```
27+
<phpunit
28+
...
29+
printerClass="clagiordano\PhpunitResultPrinter\ResultPrinter"
30+
>
31+
...
32+
</phpunit>
33+
```
34+
35+
A full phpunit.xml example:
36+
37+
```xml
38+
<?xml version="1.0" encoding="UTF-8"?>
39+
<phpunit backupGlobals="false"
40+
backupStaticAttributes="false"
41+
bootstrap="vendor/autoload.php"
42+
colors="true"
43+
convertErrorsToExceptions="true"
44+
convertNoticesToExceptions="true"
45+
convertWarningsToExceptions="true"
46+
processIsolation="false"
47+
stopOnFailure="false"
48+
verbose="true"
49+
printerClass="clagiordano\PhpunitResultPrinter\ResultPrinter"
50+
>
51+
<testsuites>
52+
<testsuite name="Package Test Suite">
53+
<directory suffix=".php">./tests/</directory>
54+
</testsuite>
55+
</testsuites>
56+
</phpunit>
57+
```
58+
59+
## Running the tests
60+
61+
You can clone and test this project with the following commands:
62+
63+
```bash
64+
git clone https://github.com/clagiordano/phpunit-result-printer.git
65+
cd phpunit-result-printer
66+
composer install
67+
./vendor/bin/phpunit
68+
```
69+
70+
One of the previous tests fails for demo purpose
71+
72+
73+
## Contributing
74+
75+
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
76+
77+
## Versioning
78+
79+
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
80+
81+
## Authors
82+
83+
* **Claudio Giordano** - *Initial work* - [clagiordano](https://github.com/clagiordano)
84+
85+
See also the list of [contributors](CONTRIBUTORS.md) who participated in this project.
86+
87+
## License
88+
89+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

0 commit comments

Comments
 (0)