summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorToru Maesaka <toru@tmaesaka.com>2012-07-11 14:30:00 +0900
committerdormando <dormando@rydia.net>2012-07-29 18:05:16 -0700
commitd342d0ae2c023d6bee16c12c5cb8aebd04cfb6cb (patch)
treead93b764bab4fcfc83a4bcb0b9da19ea3bed03e2
parent045da59d01eefdb0ff8faf9d3a28e03ba78cbc80 (diff)
downloadmemcached-d342d0ae2c023d6bee16c12c5cb8aebd04cfb6cb.tar.gz
Use Markdown for README.
-rw-r--r--README.md (renamed from README)20
1 files changed, 15 insertions, 5 deletions
diff --git a/README b/README.md
index f20dd8c..27a6896 100644
--- a/README
+++ b/README.md
@@ -1,6 +1,12 @@
-Dependencies:
+# Memcached
- -- libevent, http://www.monkey.org/~provos/libevent/ (libevent-dev)
+## 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.
@@ -11,6 +17,8 @@ epoll isn't in Linux 2.4, but there's a backport at:
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.
@@ -19,10 +27,12 @@ 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:
+## Website
+
+* http://www.memcached.org
- http://www.memcached.org
+## Contributing
Want to contribute? Up-to-date pointers should be at:
- http://contributing.appspot.com/memcached
+* http://contributing.appspot.com/memcached