Skip to content
Browse files

Update documentation

  • Loading branch information...
1 parent 3b24265 commit 8fbbe2b77f17487bca08df9d22f2badda7287447 @norton norton committed Nov 22, 2012
Showing with 9 additions and 14 deletions.
  1. +9 −14 doc/overview.edoc
View
23 doc/overview.edoc
@@ -21,10 +21,7 @@ $ mkdir working-directory-name
$ cd working-directory-name
$ git clone https://github.com/ubf/ubf-redis.git ubf_redis
$ cd ubf_redis
-$ ./rebar get-deps
-$ ./rebar clean
-$ ./rebar compile
-$ ./rebar eunit
+$ make deps clean compile test
------
For an alternative recipe with other "features" albeit more complex,
@@ -137,20 +134,20 @@ $ cd working-directory-name
$ repo sync
------
-For futher information and help for related tools, please refer to the
+For further information and help for related tools, please refer to the
following links:
- Erlang - http://www.erlang.org/
- * *R13B04 or newer, R15B has been tested most recently*
+ * *R13B04 or newer, R15B02 has been tested most recently*
- Git - http://git-scm.com/
- * *Git 1.5.4 or newer, Git 1.7.9.3 has been tested recently*
+ * *Git 1.5.4 or newer, Git 1.8.0 has been tested most recently*
* _required for Repo and GitHub_
- GitHub - https://github.com
- Python - http://www.python.org
- * *Python 2.4 or newer, Python 2.7.1 has been tested most recently
+ * *Python 2.4 or newer, Python 2.7.2 has been tested most recently
(CAUTION: Python 3.x might be too new)*
* _required for Repo_
- - Rebar - https://github.com/basho/rebar/wiki
+ - Rebar - https://github.com/rebar/rebar/wiki
- Repo - http://source.android.com/source/git-repo.html
== To build - basic recipe
@@ -217,14 +214,13 @@ true = code:add_pathz(os:getenv("HOME")++"/.erlang.d/deps/quviq/eqc-X.Y.Z/ebin")
+
------
$ cd working-directory-name
-$ make clean
-$ make eqc-compile
+$ make clean eqc
------
3. Run 5,000 Redis Encoder/Decoder QuickCheck tests
+
------
-$ cd working-directory-name/deps/ubf_redis/.eunit
+$ cd working-directory-name/deps/ubf_redis/.eqc
$ erl -smp +A 5 -pz ../../ubf/ebin -pz ../../qc/ebin
1> ruf_tests:qc_run(5000).
@@ -241,7 +237,7 @@ Ok, passed 5000 tests
4. Run 500 Redis Proxy QuickCheck tests
+
------
-$ cd working-directory-name/deps/ubf_redis/.eunit
+$ cd working-directory-name/deps/ubf_redis/.eqc
$ erl -smp +A 5 -pz ../../ubf/ebin -pz ../../qc/ebin
1> redis_proxy_tests:qc_run(500).
@@ -409,5 +405,4 @@ _Under Construction - To Be Added_
- Testing - Black Box
* Implement real "statem" test model for the Redis Proxy.
-
@end

0 comments on commit 8fbbe2b

Please sign in to comment.
Something went wrong with that request. Please try again.