From d342d0ae2c023d6bee16c12c5cb8aebd04cfb6cb Mon Sep 17 00:00:00 2001 From: Toru Maesaka Date: Wed, 11 Jul 2012 14:30:00 +0900 Subject: Use Markdown for README. --- README | 28 ---------------------------- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 28 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index f20dd8c..0000000 --- a/README +++ /dev/null @@ -1,28 +0,0 @@ -Dependencies: - - -- libevent, http://www.monkey.org/~provos/libevent/ (libevent-dev) - -If using Linux, you need a kernel with epoll. Sure, libevent will -work with normal select, but it sucks. - -epoll isn't in Linux 2.4, but there's a backport at: - - http://www.xmailserver.org/linux-patches/nio-improve.html - -You want the epoll-lt patch (level-triggered). - -If you're using MacOS, you'll want libevent 1.1 or higher to deal with -a kqueue bug. - -Also, 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) - -The memcached website is at: - - http://www.memcached.org - -Want to contribute? Up-to-date pointers should be at: - - http://contributing.appspot.com/memcached diff --git a/README.md b/README.md new file mode 100644 index 0000000..27a6896 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Memcached + +## Dependencies + +* libevent, http://www.monkey.org/~provos/libevent/ (libevent-dev) + +## Environment + +### Linux + +If using Linux, you need a kernel with epoll. Sure, libevent will +work with normal select, but it sucks. + +epoll isn't in Linux 2.4, but there's a backport at: + + http://www.xmailserver.org/linux-patches/nio-improve.html + +You want the epoll-lt patch (level-triggered). + +### Mac OS X + +If you're using MacOS, you'll want libevent 1.1 or higher to deal with +a kqueue bug. + +Also, 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) + +## Website + +* http://www.memcached.org + +## Contributing + +Want to contribute? Up-to-date pointers should be at: + +* http://contributing.appspot.com/memcached -- cgit v1.2.1