@@ -7,8 +7,9 @@ Contact information and license
77PropEr (PROPerty-based testing tool for ERlang) is a QuickCheck-inspired
88open-source property-based testing tool for Erlang, developed by Manolis
99Papadakis, Eirini Arvaniti and Kostis Sagonas. The base PropEr system was
10- written mainly by Manolis Papadakis, and the stateful code testing subsystem by
11- Eirini Arvaniti.
10+ written mainly by Manolis Papadakis, and the stateful code testing subsystem
11+ by Eirini Arvaniti. Kostis Sagonas has been actively maintaining its code
12+ base since 2012.
1213
1314You can reach PropEr's developers in the following ways:
1415
@@ -20,7 +21,7 @@ You can reach PropEr's developers in the following ways:
2021We welcome user contributions and feedback (comments, suggestions, feature
2122requests, bug reports, patches etc.).
2223
23- Copyright 2010-2013 by Manolis Papadakis, Eirini Arvaniti and Kostis Sagonas.
24+ Copyright 2010-2016 by Manolis Papadakis, Eirini Arvaniti and Kostis Sagonas.
2425
2526This program is distributed under the [ GPL] ( http://www.gnu.org/licenses/gpl.html ) ,
2627version 3 or later. Please see the COPYING file for details.
@@ -84,20 +85,22 @@ Quickstart guide
8485
8586 git clone git://github.com/manopapad/proper.git
8687
87- * Compile PropEr: Run ` make fast ` if you just want to build PropEr, optionally
88- followed by a ` make tests ` to also run its unit tests. (A plain ` make ` call
89- does a ` make fast ` but also runs dialyzer on PropEr's code base; this
90- requires having a dialyzer PLT. To also build PropEr's documentation issue
88+ * Compile PropEr: Run ` make ` if you just want to build PropEr, optionally
89+ followed by a ` make tests ` to run its unit tests and a ` make dialyzer ` call
90+ to also run dialyzer on PropEr's code base; the latter requires having a
91+ dialyzer PLT. To do the above but also build PropEr's documentation issue
9192 a ` make all ` call; in that case, you are going to need the ` syntax_tools `
9293 application and a recent version of ` EDoc ` ).
93- Optionally sfmt-erlang can be selected as an alternative random number
94+ Optionally, sfmt-erlang can be selected as an alternative random number
9495 generator using ` ./configure --use-sfmt ` before running ` make ` .
9596* Add PropEr's base directory to your Erlang library path, using one of the
9697 following methods:
98+
9799 1 . ` ERL_LIBS ` environment variable: Add the following line to your shell
98100 startup file (` ~/.bashrc ` in the case of the Bash shell):
99101
100102 export ERL_LIBS=/full/path/to/proper
103+
101104 2 . Erlang resource file: Add the following line to your ` ~/.erlang ` file:
102105
103106 code:load_abs("/full/path/to/proper").
@@ -131,16 +134,16 @@ Common problems
131134
132135### Using PropEr in conjunction with EUnit
133136
134- The main issue is that both systems define a ` ?LET ` macro. To avoid a potential
135- clash, simply include PropEr's header file before EUnit's. That way, any
136- instance of ` ?LET ` will count as a PropEr ` ?LET ` .
137+ The main issue is that both systems define a ` ?LET ` macro. To avoid a
138+ potential clash, simply include PropEr's header file before EUnit's. That
139+ way, any instance of ` ?LET ` will count as a PropEr ` ?LET ` .
137140
138141Another issue is that [ EUnit captures standard output] [ eunit stdout ] ,
139142so normally PropEr output is not visible when ` proper:quickcheck() ` is
140143invoked from EUnit. You can work around this by passing the option
141144` {to_file, user} ` to ` proper:quickcheck/2 ` . For example:
142145
143- ?assertEqual(true, proper:quickcheck(your_mod:some_prop(), [{to_file, user}]).
146+ ?assertEqual(true, proper:quickcheck(your_mod:some_prop(), [{to_file, user}]) ).
144147
145148This will make PropEr properties visible also when invoked from EUnit.
146149
0 commit comments