Skip to content

Commit

Permalink
Actually let's just cpy over the README from stable. Missed the updat…
Browse files Browse the repository at this point in the history
…ed version there.
  • Loading branch information
janoberst committed Oct 18, 2011
1 parent e491a1a commit 3fb1c8a
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions README
Expand Up @@ -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
--------------
Expand All @@ -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
-------------
Expand All @@ -40,7 +66,6 @@ parameter (the path of the configuration file):
% cd src
% ./redis-server /path/to/redis.conf


Playing with Redis
------------------

Expand Down

0 comments on commit 3fb1c8a

Please sign in to comment.