X-Git-Url: https://git.saurik.com/redis.git/blobdiff_plain/a63a3d4ddb992747020bd48f00c35158d7a447d6..cceb0c5b4a24d9027abfc47924d5f93af87034b4:/README diff --git a/README b/README index 3920b534..51152342 100644 --- a/README +++ b/README @@ -7,6 +7,13 @@ documentation at http://redis.io Building Redis -------------- +Redis can be compiled and used on Linux, OSX, OpenBSD, NetBSD, FreeBSD. +We support big endian and little endian architectures. + +It may compile on Solaris derived systems (for instance SmartOS) but our +support for this platform is "best effort" and Redis is not guaranteed to +work as well as in Linux, OSX, and *BSD there. + It is as simple as: % make @@ -62,6 +69,15 @@ parameter (the path of the configuration file): % cd src % ./redis-server /path/to/redis.conf +It is possible to alter the Redis configuration passing parameters directly +as options using the command line. Examples: + + % ./redis-server --port 9999 --slaveof 127.0.0.1 6379 + % ./redis-server /etc/redis/6379.conf --loglevel debug + +All the options in redis.conf are also supported as options using the command +line, with exactly the same name. + Playing with Redis ------------------ @@ -112,4 +128,16 @@ system reboots. You'll be able to stop and start Redis using the script named /etc/init.d/redis_, for instance /etc/init.d/redis_6379. +Code contributions +--- + +Note: by contributing code to the Redis project in any form, including sending +a pull request via Github, a code fragment or patch via private email or +public discussion groups, you agree to release your code under the terms +of the BSD license that you can find in the COPYING file included in the Redis +source distribution. + +Please see the CONTRIBUTING file in this source distribution for more +information. + Enjoy!