diff options
author | dormando <dormando@rydia.net> | 2017-02-26 10:39:40 -0800 |
---|---|---|
committer | dormando <dormando@rydia.net> | 2017-02-26 10:39:40 -0800 |
commit | 4fb3ba0116399f32065c36a993cb9ab041d57f36 (patch) | |
tree | 7bc90a81a249e37563383a3e3eb50087f4689a13 | |
parent | 9c843d2f2975b96f5754ccefbde2b0283fa62acb (diff) | |
download | memcached-4fb3ba0116399f32065c36a993cb9ab041d57f36.tar.gz |
I think the README was 12 years old.
Should make it a lot better, but here's a first pass :P
-rw-r--r-- | CONTRIBUTING | 3 | ||||
-rw-r--r-- | CONTRIBUTING.md | 9 | ||||
-rw-r--r-- | README.md | 31 |
3 files changed, 23 insertions, 20 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index e93b005..0000000 --- a/CONTRIBUTING +++ /dev/null @@ -1,3 +0,0 @@ -Want to contribute? Up-to-date pointers should be at: - - http://contributing.appspot.com/memcached diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..462a522 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +See: https://github.com/memcached/memcached/wiki/DevelopmentRepos + +It's worth repeating here, that the biggest contribution anyone can make is to +help run new releases! Any feedback we get is greatly appreciated. Hard to +know what to work on and what to prioritize if we don't hear from you :) + +The easiest thing to do is to run the latest version on one machine in your +cluster sometimes. Then when you do need to upgrade, you should also have +confidence in a well tested version. @@ -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 |