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.
  20
  21 You can run a 32 bit Redis binary using:
  22
  23     % make 32bit
  24
  25 After you build Redis is a good idea to test it, using:
  26
  27     % make test
  28
  29 Running Redis
  30 -------------
  31
  32 To run Redis with the default configuration just type:
  33
  34     % cd src
  35     % ./redis-server
  36
  37 If you want to provide your redis.conf, you have to run it using an additional
  38 parameter (the path of the configuration file):
  39
  40     % cd src
  41     % ./redis-server /path/to/redis.conf
  42
  43 Playing with Redis
  44 ------------------
  45
  46 You can use redis-cli to play with Redis. Start a redis-server instance,
  47 then in another terminal try the following:
  48
  49     % cd src
  50     % ./redis-cli
  51     redis> ping
  52     PONG
  53     redis> set foo bar
  54     OK
  55     redis> get foo
  56     "bar"
  57     redis> incr mycounter
  58     (integer) 1
  59     redis> incr mycounter
  60     (integer) 2
  61     redis>
  62
  63 You can find the list of all the available commands here:
  64
  65     http://code.google.com/p/redis/wiki/CommandReference
  66
  67 Enjoy!
  68