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

   1 # libmemcached
   2
   3 [![Gitter Badge]](https://gitter.im/m6w6/libmemcached)
   4 [![License Badge]](https://opensource.org/licenses/BSD-3-Clause)
   5
   6 [Gitter Badge]:     https://badges.gitter.im/m6w6/libmemcached.svg "Gitter Chat"
   7 [License Badge]:    https://img.shields.io/badge/License-BSD%203--Clause-blue.svg "BSD 3-Clause"
   8
   9 libmemcached is an open source C/C++ client library and tools for the
  10 memcached server (http://memcached.org/). It has been designed to be
  11 light on memory usage, thread safe, and provide full access to server
  12 side methods.
  13
  14 > **NOTE:**
  15 > This is a resurrection of the original work from Brian Aker at
  16 > [libmemcached.org](https://libmemcached.org) and the only publicly maintained
  17 > version of libmemcached currently known to me.
  18
  19 ## Documentation
  20
  21 [![Docs Actions Badge]](
  22     https://github.com/m6w6/libmemcached/actions?query=workflow%3Adocs-publish-pages)
  23
  24 [Docs Actions Badge]:
  25     https://github.com/m6w6/libmemcached/workflows/docs-publish-pages/badge.svg?branch=v1.x
  26     "Github Docs Action"
  27
  28 See https://m6w6.github.io/libmemcached
  29
  30 ### Building and updating docs
  31
  32 See [gh-pages/publish](./docs/gh-pages/publish.sh) script and the
  33 [docs-publish-pages](./.github/workflows/docs-publish-pages.yml) workflow,
  34 which automate pushing updated documentation to github pages.
  35
  36 ## Installing
  37
  38 libmemcached uses `CMake`.
  39 Please see/edit [`CMakeConfig.txt`](./CMakeConfig.txt) or use `ccmake(1)` to
  40 set any preferred options.
  41
  42 ### From source
  43
  44     git clone github.com:m6w6/libmemcached
  45     mkdir build-libmemcached
  46     cd $_
  47     cmake ../libmemcached
  48     make
  49     sudo make install
  50
  51 ## Testing
  52
  53 [![Codecov Badge]](https://codecov.io/gh/m6w6/libmemcached)
  54
  55 [Codecov Badge]:
  56     https://codecov.io/gh/m6w6/libmemcached/branch/v1.x/graph/badge.svg
  57     "Code coverage"
  58
  59 Enable the `BUILD_TESTING` setting for a build and run `make test`.
  60
  61     cmake -DBUILD_TESTING=ON ../libmemcached
  62     make test
  63
  64 ### Continuous integration
  65
  66 [![Travis Badge]](https://travis-ci.org/github/m6w6/libmemcached)
  67 [![Actions Badge]](https://github.com/m6w6/libmemcached/actions?query=workflow%3Acmake-build-ci)
  68 [![Sourcehut Badge]](https://builds.sr.ht/~m6w6/libmemcached)
  69
  70 [Travis Badge]:
  71     https://api.travis-ci.org/m6w6/libmemcached.svg?branch=v1.x
  72     "Travis CI"
  73 [Actions Badge]:
  74     https://github.com/m6w6/libmemcached/workflows/cmake-build-ci/badge.svg?branch=v1.x
  75     "Github Actions"
  76 [Sourcehut Badge]:
  77     https://builds.sr.ht/~m6w6/libmemcached/commits.svg
  78     "Sourcehut Builds"
  79
  80 CI/Test results are performed on the follwing system matrix:
  81
  82 | OS               | Compiler                     | Arch                  |
  83 |------------------|------------------------------|-----------------------|
  84 | Linux            | GNU 9                        | arm64, ppc64le, s390x |
  85 | Linux            | GNU 7/8/9/10, Clang 6/8/9/10 | amd64                 |
  86 | MacOS            | Clang 12 (apple)             | amd64                 |
  87 | FreeBSD, OpenBSD | Clang 8                      | amd64                 |
  88
  89 libmemcached has been tested against [memcached](https://github.com/memcached/memcached) v1.5 and v1.6.
  90
  91 ## ChangeLog
  92
  93 Check out the latest [releases](https://github.com/m6w6/libmemcached/releases)
  94 or the bundled [ChangeLog](./ChangeLog.md) for a comprehensive list of changes.
  95
  96 ## License
  97
  98 libmemcached is licensed under the 3-Clause-BSD license, which can be
  99 found in the accompanying [LICENSE](./LICENSE) file.
 100
 101 ## Contributing
 102
 103 Please report any issues on the [bug tracker](https://github.com/m6w6/libmemcached/issues).
 104
 105 A list of known permanent issues is maintained in [BUGS](./BUGS.md).
 106
 107 All forms of contribution are welcome! Please see the bundled
 108 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
 109
 110 The list of current and past maintainers and contributors is available in [AUTHORS](./AUTHORS).
 111