README.md: add linux locks example

[model-checker.git] / README.md

diff --git a/README.md b/README.md
index 5132935423d28648cee0715d04bd9015fc1bb180..9804a28b43b101c451f7e2a4b74a5c69483b6664 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-CDSChecker Readme
-=================
+CDSChecker: A Model Checker for C11 and C++11 Atomics
+=====================================================
 
 Copyright © 2013 Regents of the University of California. All rights reserved.
 
@@ -16,7 +16,7 @@ execution behaviors and to significantly shrink the state space. The model
 checking algorithm is described in more detail in this paper (published in
 OOPSLA '13):
 
-  <http://demsky.eecs.uci.edu/publications/c11modelcheck.pdf>
+>   <http://demsky.eecs.uci.edu/publications/c11modelcheck.pdf>
 
 It is designed to support unit tests on concurrent data structure written using
 C/C++ atomics.
@@ -32,16 +32,13 @@ CDSChecker should compile on Linux and Mac OSX with no dependencies and has been
 tested with LLVM (clang/clang++) and GCC. It likely can be ported to other \*NIX
 flavors. We have not attempted to port to Windows.
 
-You may also refer to the CDSChecker project page:
-
-  <http://demsky.eecs.uci.edu/c11modelchecker.php>
-
 
 Getting Started
 ---------------
 
 If you haven't done so already, you may download CDSChecker using
-[git](http://git-scm.com/):
+[git](http://git-scm.com/) (for those without git, snapshots can be found at the
+Gitweb URLs below):
 
       git clone git://demsky.eecs.uci.edu/model-checker.git
 
@@ -124,8 +121,9 @@ the benchmarks as follows:
 
 >     make benchmarks
 >     cd benchmarks
->     ./run.sh barrier/barrier -y -m 2     # runs barrier test with fairness/memory liveness
->     ./bench.sh                           # run all benchmarks and provide timing results
+>     ./run.sh barrier/barrier -y -m 2           # runs barrier test with fairness/memory liveness
+>     ./run.sh linuxrwlocks/linuxrwlocks -y -m 2 # Linux RW locks test with fairness/liveness
+>     ./bench.sh                                 # run all benchmarks and provide timing results
 
 
 Running your own code
@@ -275,6 +273,20 @@ Other Notes
   CDSChecker with the `-u num` option.
 
 
+See Also
+--------
+
+The CDSChecker project page:
+
+>   <http://demsky.eecs.uci.edu/c11modelchecker.php>
+
+The CDSChecker source and accompanying benchmarks on Gitweb:
+
+>   <http://demsky.eecs.uci.edu/git/?p=model-checker.git>
+>
+>   <http://demsky.eecs.uci.edu/git/?p=model-checker-benchmarks.git>
+
+
 Contact
 -------