README.md: point non-git users to gitweb
[model-checker.git] / README.md
index ec10620166721e921b11a6dca286c27ca42f7e57..e020ad42a6592762a06ea4b611b240de506e4b91 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@ Copyright © 2013 Regents of the University of California. All rights reserv
 
 CDSChecker is distributed under the GPL v2. See the LICENSE file for details.
 
+
 Overview
 --------
 
@@ -15,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.
@@ -31,15 +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
 
@@ -65,6 +64,7 @@ To see the help message on how to run CDSChecker, execute:
 
       ./run.sh -h
 
+
 Useful Options
 --------------
 
@@ -110,6 +110,7 @@ or
 
 >     -m 2 -f 10
 
+
 Benchmarks
 -------------------
 
@@ -123,6 +124,7 @@ the benchmarks as follows:
 >     ./run.sh barrier/barrier -y -m 2     # runs barrier test with fairness/memory liveness
 >     ./bench.sh                           # run all benchmarks and provide timing results
 
+
 Running your own code
 ---------------------
 
@@ -157,6 +159,7 @@ the headers in the `include/` directory. Then the shared library must be made
 available to the dynamic linker, using the `LD_LIBRARY_PATH` environment
 variable, for instance.
 
+
 Reading an execution trace
 --------------------------
 
@@ -269,6 +272,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
 -------