Merge pull request #77 from Poincare/patch-1

[redis.git] / README

diff --git a/README b/README
index 1f0a1fe645da1e618b9bd886abe3c1bc00cd3fa0..088844b795747c4d75e524df3c975545c338317d 100644 (file)
--- a/README
+++ b/README
@@ -15,18 +15,35 @@ It is as simple as:
     % make
 
 Redis is just a single binary, but if you want to install it you can use
-the "make install" target that will copy the binary in /usr/local/bin
-for default. You can also use "make PREFIX=/some/other/directory install"
+the "make install" target that will copy the binary to /usr/local/bin
+by default. You can also use "make PREFIX=/some/other/directory install"
 if you wish to use a different destination.
 
 You can run a 32 bit Redis binary using:
 
     % make 32bit
 
-After you build Redis is a good idea to test it, using:
+After you build Redis is a good idea to test it (which require Tcl), using:
 
     % make test
 
+Buliding using tcmalloc
+-----------------------
+
+tcmalloc is a fast and space efficient implementation (for little objects)
+of malloc(). Compiling Redis with it can improve performance and memory
+usage. You can read more about it here:
+
+http://goog-perftools.sourceforge.net/doc/tcmalloc.html
+
+In order to compile Redis with tcmalloc support, install tcmalloc on your system
+and then use:
+
+    % make USE_TCMALLOC=yes
+
+Note that you can pass any other target to make, as long as you append
+USE_TCMALLOC=yes at the end.
+
 Running Redis
 -------------