markdown readme

diff --git a/readme.md b/readme.md
new file mode 100644 (file)
index 0000000..57524ea
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,77 @@
+CDS C++ library\r
+===============\r
+\r
+The Concurrent Data Structures (CDS) library is a collection of concurrent data structures \r
+that don't require external (manual) synchronization, and safe memory reclamation (SMR) \r
+algorithms like Hazard Pointer and user-space RCU. CDS is mostly header-only template library. \r
+Only SMR core implementation is segregated to .so (or .dll) file.\r
+\r
+The library contains the implementations of the following containers:\r
+  - lock-free stack with optional elimination support\r
+  - several algo for lock-free queue, including classic Michael & Scott algorithm and it's derivatives,\r
+    flat combining queue, segmented queue.\r
+  - several implementation of unordered set/map - lock-free and fine-grained lock-based\r
+  - lock-free skip-list\r
+  \r
+Generally, each container has an intrusive and non-intrusive (STL-like) version belonging to \r
+cds::intrusive and cds::container namespace respectively.\r
+\r
+Version 2.x of the library is written on C++11 and can be compiled by GCC 4.8+, clang 3.3+, Intel C++ 15+, \r
+and MS VC++ 12 (2013) Update 4.\r
+\r
+Download the latest release from http://sourceforge.net/projects/libcds/files/.\r
+\r
+References\r
+----------\r
+Stack:\r
+    - TreiberStack: [1986] R. K. Treiber. Systems programming: Coping with parallelism. Technical Report RJ 5118, IBM Almaden Research Center, April 1986.\r
+    - Elimination back-off implementation is based on idea from \r
+      [2004] Danny Hendler, Nir Shavit, Lena Yerushalmi "A Scalable Lock-free Stack Algorithm"\r
+        \r
+Queue:\r
+    - BasketQueue: [2007] Moshe Hoffman, Ori Shalev, Nir Shavit "The Baskets Queue"\r
+    - MSQueue\r
+        * [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
+        * [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-free objects using atomic reads and writes"\r
+        * [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects"\r
+    - RWQueue: [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
+    - MoirQueue: [2000] Simon Doherty, Lindsay Groves, Victor Luchangco, Mark Moir "Formal Verification of a practical lock-free queue algorithm"\r
+    - OptimisticQueue: [2008] Edya Ladan-Mozes, Nir Shavit "An Optimistic Approach to Lock-Free FIFO Queues"\r
+    - SegmentedQueue: [2010] Afek, Korland, Yanovsky "Quasi-Linearizability: relaxed consistency for improved concurrency"\r
+    - TsigasCycleQueue: [2000] Philippas Tsigas, Yi Zhang "A Simple, Fast and Scalable Non-Blocking Concurrent FIFO Queue for Shared Memory Multiprocessor Systems"\r
+    - VyukovMPMCCycleQueue Dmitry Vyukov (see http://www.1024cores.net)\r
+\r
+Deque:\r
+    MichaelDeque: [2003] Maged Michael "CAS-based Lock-free Algorithm for Shared Deque"\r
+\r
+Map, set:\r
+    - MichaelHashMap: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
+    - SplitOrderedList: [2003] Ori Shalev, Nir Shavit "Split-Ordered Lists - Lock-free Resizable Hash Tables"\r
+    - StripedMap, StripedSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
+    - CuckooMap, CuckooSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
+    - SkipListMap, SkipListSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
+        \r
+Ordered single-linked list (buckets for the map):\r
+    - LazyList: [2005] Steve Heller, Maurice Herlihy, Victor Luchangco, Mark Moir, William N. Scherer III, and Nir Shavit "A Lazy Concurrent List-Based Set Algorithm"\r
+    - MichaelList: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
+\r
+Priority queue:\r
+    - MSPriorityQueue: [1996] G.Hunt, M.Michael, S. Parthasarathy, M.Scott "An efficient algorithm for concurrent priority queue heaps"\r
+\r
+Tree:\r
+    - EllenBinTree: [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"\r
+\r
+Garbage collection:\r
+    - Hazard Pointers\r
+        * [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-freeobjects using atomic reads and writes"\r
+        * [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects"\r
+        * [2004] Andrei Alexandrescy, Maged Michael "Lock-free Data Structures with Hazard Pointers"\r
+    - User-space RCU\r
+        * [2009] M.Desnoyers "Low-Impact Operating System Tracing" PhD Thesis,\r
+                 Chapter 6 "User-Level Implementations of Read-Copy Update"\r
+        * [2011] M.Desnoyers, P.McKenney, A.Stern, M.Dagenias, J.Walpole "User-Level\r
+                 Implementations of Read-Copy Update"\r
+\r
+Memory allocation: [2004] M.Michael "Scalable Lock-free Dynamic Memory Allocation"\r
+\r
+Flat Combining technique: [2010] Hendler, Incze, Shavit and Tzafrir "Flat Combining and the Synchronization-Parallelism Tradeoff"\r