Skip to content

Commit

Permalink
minor #24 remove indications that are not used anymore (cordoval)
Browse files Browse the repository at this point in the history
This PR was merged into the master branch.

Discussion
----------

|Q            |A  |
|---          |---|
|Bug Fix?     |n  |
|New Feature? |n  |
|BC Breaks?   |n  |
|Deprecations?|n  |
|Tests Pass?  |n  |
|Fixed Tickets|   |
|License      |MIT|
|Doc PR       |   |

Commits
-------

3b87746 remove indications that are not used anymore
ce6e451 add gush formatter for PRs
  • Loading branch information
cordoval committed Jan 21, 2015
2 parents ca2db15 + ce6e451 commit 18ec485
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 43 deletions.
7 changes: 7 additions & 0 deletions .gush.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
adapter: github
issue_tracker: github
meta-header: "Copyright (c) 2009-2015 hamcrest.org"
table-pr:
fixed_tickets: ['Fixed Tickets', '']
license: ['License', MIT]
base: master
44 changes: 1 addition & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,51 +40,9 @@ Exceptions, mostly down to PHP language barriers:
Usage
-----

To use Hamcrest, add the hamcrest directory to your include path and then
simply include hamcrest.php to gain access to each of the Hamcrest matchers.
Hamcrest matchers are easy to use as:

```php
set_include_path(
'hamcrest-php/hamcrest' . PATH_SEPARATOR .
get_include_path()
);

require_once 'hamcrest.php';

assertThat('a', equalToIgnoringCase('A'));
```

hamcrest.php uses global function names. If you really need namespaced ones
(which won't look as fluent), include "hamcrest/Hamcrest/Matchers.php" and
"hamcrest/Hamcrest/MatcherAssert.php".

```php
set_include_path(
'hamcrest-php/hamcrest' . PATH_SEPARATOR .
get_include_path()
);

require_once 'hamcrest/Hamcrest/MatcherAssert.php';
require_once 'hamcrest/Hamcrest/Matchers.php';

Hamcrest_MatcherAssert::assertThat('a', Hamcrest_Matchers::equalToIgnoringCase('A'));
```

Composer Package
----------------

Hamcrest is available as the [Composer](https://getcomposer.org/) package
[hamcrest/hamcrest-php](https://packagist.org/packages/hamcrest/hamcrest-php).

Using Hamcrest via Composer means there is no need to manually `require()` any
files. Simply include the package as a dependency, and include the Composer
class loader as normal, and you will have access to both the global functions,
and the Hamcrest classes:

```php
require '/path/to/vendor/autoload.php';

assertThat('a', equalToIgnoringCase('A'));
Hamcrest_MatcherAssert::assertThat('a', Hamcrest_Matchers::equalToIgnoringCase('A'));
```

Expand Down

0 comments on commit 18ec485

Please sign in to comment.