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

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