git.m6w6.name Git - awesomized/libmemcached/blob - README.md

   1 # libmemcached
   2
   3 [![Build Status](https://travis-ci.org/m6w6/libmemcached.svg?branch=v1.0)](https://travis-ci.org/m6w6/libmemcached)
   4
   5 libmemcached is an open source C/C++ client library and tools for the
   6 memcached server (http://memcached.org/). It has been designed to be
   7 light on memory usage, thread safe, and provide full access to server
   8 side methods.
   9
  10 > **NOTE:**
  11 > This is a resurrection of the original work from Brian Aker at
  12 > [libmemcached.org](https://libmemcached.org) and the only publicly maintained
  13 > version of libmemcached currently known to me.
  14
  15 ## Documentation
  16
  17 See https://m6w6.github.io/libmemcached
  18
  19 ## Installing
  20
  21 libmemcached uses `CMake`. Please see/edit `CMakeConfig.txt` or use
  22 `ccmake(1)` to set any preferred options.
  23
  24 ### From source
  25
  26         git clone github.com:m6w6/libmemcached
  27         mkdir build-libmemcached
  28         cd $_
  29         cmake ../libmemcached
  30         make
  31         sudo make install
  32
  33 ## Testing
  34
  35 Enable the `BUILD_TESTING` setting for a build and run `make test`.
  36
  37     cmake -DBUILD_TESTING=ON ../libmemcached
  38     make test
  39
  40 ### Continuous integration
  41
  42 CI/Test results are available at [Travis CI](https://travis-ci.org/m6w6/libmemcached).
  43
  44 ## ChangeLog
  45
  46 Check out the latest [releases](./releases) or the bundled
  47 [ChangeLog](./ChangeLog) for a comprehensive list of changes.
  48
  49 ## License
  50
  51 libmemcached is licensed under the 3-Clause-BSD license, which can be
  52 found in the accompanying [LICENSE](./LICENSE) file.
  53
  54 ## Contributing
  55
  56 All forms of contribution are welcome! Please see the bundled
  57 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
  58
  59 The list of past and current contributors is maintained in [THANKS](./THANKS).
  60
  61 The list of current maintainers is available in [AUTHORS](./AUTHORS).
  62
  63 ### Building and updating docs
  64
  65 See [gh-pages/publish](./docs/gh-pages/publish.sh) script, which automates
  66 pushing updated documentation to github pages.
  67