Merge branch 'master' of /home/git/concurrency-benchmarks

[c11concurrency-benchmarks.git] / README.md

diff --git a/README.md b/README.md
index 15958b3965cc3dc3a09cbc533cd6ac5ddf5e07e6..f05c675dc742d607edceb242d2063e8fccccc76d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,11 @@
+C11Tester Concurrency Benchmarks
+================================
+
+This is a set of benchmarks that make use of C/C++11 atomic operations.
+
+Getting Started
+---------------
+
 To get things working one has to come up with the following Build/Runtime Dependencies.
 Corresponding command for Ubuntu is included for convenience.
 
@@ -10,11 +18,28 @@ Corresponding command for Ubuntu is included for convenience.
 3. GLIBC
 -- sudo apt-get install libc6
 
-4. g++ Compiler that supports C++11
--- sudo apt-get install g++
+4. LLVM Compiler that supports C++11 w/o C11Tester instrumentation passes
 
 5. packages for Silo
 
 sudo apt-get install libdb++-dev
 sudo apt-get install libaio-dev
 sudo apt-get install libjemalloc-dev
+
+6. Edit the scripts clang, clang++, g++, gcc, and run with the appropriate
+paths for your system.
+
+7.  Each benchmark contains a script compile.sh to build the benchmark
+and run.sh to run the benchmark.
+
+Acknowledgments
+---------------
+
+This material is based upon work supported by the National Science
+Foundation under Grant Numbers 1740210 and 1319786 and Google Research
+awards.
+
+Any opinions, findings, and conclusions or recommendations expressed
+in this material are those of the author(s) and do not necessarily
+reflect the views of the National Science Foundation.
+