You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by va...@apache.org on 2017/09/28 21:02:57 UTC
[49/50] meck commit: updated refs/heads/master to 3544aca
Update for latest version and Rebar 3
Project: http://git-wip-us.apache.org/repos/asf/couchdb-meck/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-meck/commit/2754b5c9
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-meck/tree/2754b5c9
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-meck/diff/2754b5c9
Branch: refs/heads/master
Commit: 2754b5c9bca8e7d5803654d675c15852a5b876db
Parents: cb155ca
Author: Adam Lindberg <he...@alind.io>
Authored: Thu Sep 7 10:21:00 2017 +0200
Committer: GitHub <no...@github.com>
Committed: Thu Sep 7 10:21:00 2017 +0200
----------------------------------------------------------------------
README.md | 44 +++++++++++++++++++++++++-------------------
1 file changed, 25 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb-meck/blob/2754b5c9/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index ccce8c8..bba133c 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ A mocking library for Erlang.
* [Features](#features)
* [Examples](#examples)
* [Use](#use)
- * [Build](#build)
+ * [Manual Build](#manual-build)
* [Caveats](#caveats)
* [Contribute](#contribute)
@@ -147,34 +147,46 @@ ok
Use
---
-Meck is best used via [Rebar 3][rebar_3]. Add the following dependency to your
-`rebar.config` in your project root:
+Meck is best used via [Rebar 3][rebar_3]. Add Meck to the test dependencies
+in your `rebar.config` for your project:
```erlang
-{deps, [
- {meck, "0.8.4"}
+{profiles, [
+ {test, [
+ {deps, [
+ {meck, "0.8.8"}
+ ]}
+ ]}
]}.
```
-Build
------
+Manual Build
+------------
-Meck requires `make` and [Rebar 2][rebar_2] to build (included in the
-repository, to be upgraded to Rebar 3). To build Meck go to the Meck directory
+Meck uses [Rebar 3][rebar_3]. To build Meck go to the Meck directory
and simply type:
```sh
-make
+rebar3 compile
```
In order to run all tests for Meck type the following command from the same
directory:
```sh
-make test
+rebar3 eunit
```
-Two things might seem alarming when running the tests:
+Documentation can be generated through the use of the following command:
+
+```sh
+rebar3 edoc
+```
+
+### Test Output
+
+Normally the test output is hidden using [Unite][unite]. If EUnit is run
+directly, two things might seem alarming when running the tests:
1. Warnings emitted by cover
2. An exception printed by SASL
@@ -183,12 +195,6 @@ Both are expected due to the way Erlang currently prints errors. The important
line you should look for is `All XX tests passed`, if that appears all is
correct.
-Documentation can be generated through the use of the following command:
-
-```sh
-make doc
-```
-
Caveats
-------
@@ -271,8 +277,8 @@ donations][coinbase] are greatly appreciated!
<!-- Links -->
[release_notes_0.8]: https://github.com/eproxus/meck/wiki/0.8-Release-Notes
[hamcrest]: https://github.com/hyperthunk/hamcrest-erlang
-[rebar_2]: https://github.com/rebar/rebar
[rebar_3]: https://github.com/erlang/rebar3
+[unite]: https://github.com/eproxus/unite
[issues]: http://github.com/eproxus/meck/issues
[commit_messages]: http://chris.beams.io/posts/git-commit/
[coinbase]: https://www.coinbase.com/alind