[virtualcommons-svn] commit/foraging: alllee: more readme refinement

[<com...@bi...>]

1 new commit in foraging:

https://bitbucket.org/virtualcommons/foraging/commits/c2f8d90d09e0/
Changeset:   c2f8d90d09e0
User:        alllee
Date:        2014-05-20 21:05:32
Summary:     more readme refinement
Affected #:  1 file

diff -r b4c22fc8d4523fe56a269b0ac5ad0d4024f850a4 -r c2f8d90d09e0357d96b811c7ff334acb7c774b20 README.md
--- a/README.md
+++ b/README.md
@@ -1,20 +1,25 @@
 ### foraging
 
 The foraging experiment is a common pool resource experiment where participants are placed in randomized groups and
-interact with a spatially explicit virtual resource environment. It is built on the
+interact with a spatially explicit renewable resource. It is built on the
 [csidex](http://bitbucket.org/virtualcommons/csidex) experiment framework and has been used to conduct research studies
 at [Arizona State University](http://www.asu.edu), [Indiana University](http://www.iu.edu), and the [University of Alaska-Anchorage](http://www.uaa.alaska.edu).
 
 ### features
 
-* participants move and interact with a resource in a real-time 2-D grid environment. 
-* Easily pluggable resource growth dynamics. The default is a parameterized density-dependent growth function but there
+* Participants move and interact with a resource in a real-time 2-D grid environment. 
+* Pluggable resource growth dynamics. The default is a parameterized density-dependent growth function but there
   are also "patchy" resource growth dynamics where the top half of the grid has a higher chance of regrowth than the
   bottom half. Arbitrary regrowth dynamics are possible by implementing a Java interface and specifying it in a
   configuration file.
-* support for interactive quizzes, logged chat, message censoring, voting, and sanctioning
-* binary and XML savefiles that store every user action in a time ordered stream that can be converted to QuickTime
-  movies and replayed.
+* Flexible experiment and round scoped parameterization via [Java properties files](http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html) used to define experimental treatments.
+  Experiment scoped parameters apply to the entire experiment whereas round scoped parameters apply to a specific round.
+* Support for interactive quizzes, monitored real-time chat with options for censoring, voting, sanctioning, mini trust
+  games in between rounds, embedded links that uniquely and anonymously identify each participant to Qualtrics surveys
+  and limited fields of vision.
+* Binary and XML savefiles that store every user action (e.g., movement, harvest events, sanction events, chats) in a time
+  ordered stream that can be converted to a variety of CSV statistics files and into QuickTime movies. Custom data
+  analysis can be done by extending the SaveFileConverter class and analyzing the OrderedSet of user actions.
 
 ### how to run the software
 
@@ -22,11 +27,11 @@
 
 * [install and setup Java, Ant, and Maven](https://bitbucket.org/virtualcommons/csidex/wiki/Home)
 * [download and unpack the foraging codebase](https://bitbucket.org/virtualcommons/foraging/downloads)
-* From the command-line (e.g., Windows PowerShell or Command Prompt, Mac OSX Terminal.app, or any Linux terminal program)
+* From the command-line (e.g., Windows PowerShell or Command Prompt, Mac OSX Terminal.app, or any Linux terminal)
 ```
 #!bash
 % ant prepare-demo
-% ant demo
+% ant demo % this will start a server, a facilitator, and 5 clients in the demo treatment
 ```
 For more detailed instructions, please see the [installation instructions on our wiki](https://bitbucket.org/virtualcommons/foraging/wiki/Installation).

Repository URL: https://bitbucket.org/virtualcommons/foraging/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.