From: Karl Malbrain <malbrain@cal.berkeley.edu>
Date: Thu, 2 Jan 2014 22:20:25 +0000 (-0800)
Subject: Readme file
X-Git-Url: https://pd.if.org/git/?p=btree;a=commitdiff_plain;h=358f610eba67ff7c02611425689c99f13e1502f7

Readme file
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..12a2625
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+Btree-source-code
+=================
+
+A working project for High-concurrency B-tree source code in C
+
+There are three major code sets in the btree source code:
+
+btree2q.c       Single Threaded/MultiProcess with latching supplied by advisory file locking.  Works with network file systems.
+threads2h.c     Multi-Threaded/Multi-Process with latching implemented with test & set locks in the btree pages.
+
+The Foster set includes three types of latching:
+
+Fosterbtreee.c  Multi-Threaded/Single Process with latches hosted by the buffer pool manager
+Fosterbtreef.c  Multi-Threaded/Multi-Process with latches hosted by a latch manager using the first few pages of the btree.
+Fosterbtreeg.c  Multi-Threaded/Multi-Process with latches implemented with test & set locks in the btree pages.
+
+Compilation is achieved on linux or Windows by:
+
+gcc -D STANDALONE threads2h.c -lpthread
+
+or
+
+cl /D STANDALONE threads2h.c
+
+Please see the project home page at code.google.com/p/high-concurrency-btree