diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 14 insertions, 17 deletions
@@ -1,28 +1,27 @@ # Memcached -## Dependencies - -* libevent, http://www.monkey.org/~provos/libevent/ (libevent-dev) +Memcached is a high performance multithreaded event-based key/value cache +store intended to be used in a distributed system. -## Environment +See: https://memcached.org/about -### Linux +A fun story explaining usage: https://memcached.org/tutorial -If using Linux, you need a kernel with epoll. Sure, libevent will -work with normal select, but it sucks. +If you're having trouble, try the wiki: https://memcached.org/wiki -epoll isn't in Linux 2.4, but there's a backport at: +If you're trying to troubleshoot odd behavior or timeouts, see: +https://memcached.org/timeouts - http://www.xmailserver.org/linux-patches/nio-improve.html +https://memcached.org/ is a good resource in general. Please use the mailing +list to ask questions, github issues aren't seen by everyone! -You want the epoll-lt patch (level-triggered). +## Dependencies -### Mac OS X +* libevent, http://www.monkey.org/~provos/libevent/ (libevent-dev) -If you're using MacOS, you'll want libevent 1.1 or higher to deal with -a kqueue bug. +## Environment -Also, be warned that the -k (mlockall) option to memcached might be +Be warned that the -k (mlockall) option to memcached might be dangerous when using a large cache. Just make sure the memcached machines don't swap. memcached does non-blocking network I/O, but not disk. (it should never go to disk, or you've lost the whole point of it) @@ -33,6 +32,4 @@ should never go to disk, or you've lost the whole point of it) ## Contributing -Want to contribute? Up-to-date pointers should be at: - -* http://contributing.appspot.com/memcached +See https://github.com/memcached/memcached/wiki/DevelopmentRepos |