README

   1 Where to find complete Redis documentation?
   2 -------------------------------------------
   3
   4 This README is just a fast "quick start" document. You can find more detailed
   5 documentation here:
   6
   7 1) http://code.google.com/p/redis
   8 2) Check the 'doc' directory. doc/README.html is a good starting point :)
   9
  10 Building Redis
  11 --------------
  12
  13 It is as simple as:
  14
  15     % make
  16
  17 Redis is just a single binary, but if you want to install it you can use
  18 the "make install" target that will copy the binary in /usr/local/bin
  19 for default. You can also use "make PREFIX=/some/other/directory install"
  20 if you wish to use a different destination.
  21
  22 You can run a 32 bit Redis binary using:
  23
  24     % make 32bit
  25
  26 After you build Redis is a good idea to test it, using:
  27
  28     % make test
  29
  30 Running Redis
  31 -------------
  32
  33 To run Redis with the default configuration just type:
  34
  35     % cd src
  36     % ./redis-server
  37
  38 If you want to provide your redis.conf, you have to run it using an additional
  39 parameter (the path of the configuration file):
  40
  41     % cd src
  42     % ./redis-server /path/to/redis.conf
  43
  44 Playing with Redis
  45 ------------------
  46
  47 You can use redis-cli to play with Redis. Start a redis-server instance,
  48 then in another terminal try the following:
  49
  50     % cd src
  51     % ./redis-cli
  52     redis> ping
  53     PONG
  54     redis> set foo bar
  55     OK
  56     redis> get foo
  57     "bar"
  58     redis> incr mycounter
  59     (integer) 1
  60     redis> incr mycounter
  61     (integer) 2
  62     redis>
  63
  64 You can find the list of all the available commands here:
  65
  66     http://code.google.com/p/redis/wiki/CommandReference
  67
  68 Enjoy!
  69