Permalink
Browse files

Actually let's just cpy over the README from stable. Missed the updat…

…ed version there.
  • Loading branch information...
1 parent e491a1a commit 3fb1c8a0bc4206fabf78a0d8d349906c87446858 @janoberst janoberst committed Oct 18, 2011
Showing with 31 additions and 6 deletions.
  1. +31 −6 README
View
37 README
@@ -2,8 +2,7 @@ Where to find complete Redis documentation?
-------------------------------------------
This README is just a fast "quick start" document. You can find more detailed
-documentation here: http://redis.io/documentation
-
+documentation at http://redis.io
Building Redis
--------------
@@ -13,18 +12,45 @@ 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 to /usr/local/bin
-by default. You can also use "make PREFIX=/some/other/directory install"
+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"
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 (which require Tcl), using:
+After building Redis is a good idea to test it, using:
% make test
+NOTE: if after building Redis with a 32 bit target you need to rebuild it
+ with a 64 bit target you need to perform a "make clean" in the root
+ directory of the Redis distribution.
+
+Allocator
+---------
+
+By default Redis compiles and links against jemalloc under Linux, since
+glibc malloc() has memory fragmentation problems.
+
+To force a libc malloc() build use:
+
+ make FORCE_LIBC_MALLOC=yes
+
+In all the other non Linux systems the libc malloc() is used by default.
+
+On Mac OS X you can force a jemalloc based build using the following:
+
+ make USE_JEMALLOC=yes
+
+Verbose build
+-------------
+
+Redis will build with a user friendly colorized output by default.
+If you want to see a more verbose output use the following:
+
+ make V=1
Running Redis
-------------
@@ -40,7 +66,6 @@ parameter (the path of the configuration file):
% cd src
% ./redis-server /path/to/redis.conf
-
Playing with Redis
------------------

0 comments on commit 3fb1c8a

Please sign in to comment.