Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added build and test instructions to the README.

Change-Id: I542e4137731da94a4609c46d3ba25238e8fe2874
Reviewed-on: http://review.couchbase.org/14595
Tested-by: Aliaksey Kandratsenka <alkondratenko@gmail.com>
Reviewed-by: Aliaksey Kandratsenka <alkondratenko@gmail.com>
  • Loading branch information...
commit ebc440610fd73a2d994677579ec019ceb519e307 1 parent 3743c6a
@snej snej authored alk committed
Showing with 36 additions and 1 deletion.
  1. +36 −1 README.md
View
37 README.md
@@ -1,6 +1,41 @@
# Couchbase (.couch) storage file C library
-Dependencies:
+## Dependencies:
* libei, from the `erl_interface` OTP library. Will be detected if erlang is installed.
* snappy.
+ * Lua interpreter, to run the test suite
+
+## How To Build:
+
+ 1. `config/autorun.sh`
+ 2. `./configure`
+ 3. `make`
+
+Build output library will be in the (invisible) .libs directory -- i.e. `.libs/libcouchstore.dylib` on Mac OS, or `.libs/libcouchstore.so` on Linux.
+
+## Tests:
+
+ 1. `make test`
+
+This will run the native tests, and also the Lua tests if Lua was installed at the time the `configure` script ran.
+
+If the tests pass, the output should look something like:
+
+ opening nonexistent file errors... OK
+ dump empty db... OK
+ save_doc... OK
+ save_docs... OK
+ local docs... OK
+ compressed bodies... OK
+ changes no dupes... OK
+ PASS: testapp
+ ==================
+ All 1 tests passed
+ ==================
+ Running lua tests.
+ Local doc test: PASS
+ Simple truncation test: PASS
+ Various mangling of headers: PASS
+ Explicit bulk test: PASS
+ Big bulk test: PASS
Please sign in to comment.
Something went wrong with that request. Please try again.