Permalink
Browse files

Minor change in documentation

  • Loading branch information...
1 parent 9777cfa commit 46aa0a72584870669d41e9de7a4092eb98277517 @manopapad committed Jul 24, 2011
Showing with 6 additions and 3 deletions.
  1. +1 −1 README.md
  2. +5 −2 doc/overview.edoc
View
@@ -77,7 +77,7 @@ Quickstart guide
* Obtain a copy of PropEr's sources.
* Compile PropEr: run `make` (or `make all`, if you also want to build the
- documentation; in that case, you are going to need the syntax_tools
+ documentation; in that case, you are going to need the `syntax_tools'
application and a recent version of `EDoc`).
* Add PropEr's base directory to your Erlang library path, using one of the
following methods:
View
@@ -26,8 +26,11 @@ This is the source for PropEr's overview page.
@title PropEr: A QuickCheck-inspired property-based testing tool for Erlang
-@doc This is PropEr's reference manual. The bulk of the PropEr API is contained
-in the documentation for the following modules:
+@doc This is PropEr's Reference Manual. If you are new to PropEr, you should
+first read the User Guide (available online at
+<a href="http://proper.softlab.ntua.gr/" target="_top">PropEr's website</a>,
+and also in PropEr's README file). The bulk of the PropEr API is contained in
+the documentation for the following modules:
<dl>
<dt>{@link proper}</dt>

0 comments on commit 46aa0a7

Please sign in to comment.