3 [![License Badge]](https://opensource.org/licenses/BSD-3-Clause)
5 [License Badge]: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg "BSD 3-Clause"
7 libmemcached is an open source C/C++ client library and tools for the
8 memcached server (http://memcached.org/). It has been designed to be
9 light on memory usage, thread safe, and provide full access to server
13 > This is a resurrection of the original work from Brian Aker at
14 > [libmemcached.org](https://libmemcached.org).
18 [![Docs Actions Badge]](
19 https://github.com/awesomized/libmemcached/actions?query=workflow%3Adocs-publish-pages)
22 https://github.com/awesomized/libmemcached/workflows/docs-publish-pages/badge.svg?branch=v1.x
25 See https://awesomized.github.io/libmemcached
27 ### Building and updating docs
29 See [gh-pages/publish](./docs/gh-pages/publish.sh) script and the
30 [docs-publish-pages](./.github/workflows/docs-publish-pages.yml) workflow,
31 which automate pushing updated documentation to github pages.
35 libmemcached uses `CMake`.
36 Please see/edit [`CMakeConfig.txt`](./CMakeConfig.txt) or use `ccmake(1)` or
37 `cmake-gui(1)` to set any preferred options.
41 git clone github.com:awesomized/libmemcached
42 mkdir build-libmemcached
52 * GNU Bison 2.3+ and Flex
54 ##### Optional dependencies
56 * C++17 compiler (required for: tests)
57 * Intel's libtbb (optional for: tests; for GCC's stdlib parallelism support)
58 * pthreads (required for: tests, contrib/bin/memaslap, libmemcachedutil/pool)
59 * libevent (required for: contrib/bin/memaslap)
60 * Cyrus' libsasl2 (required for: libmemcached/sasl)
64 CI and release builds for Linux, a couple BSDs, MacOS and Windows are available at
65 https://artifacts.m6w6.name/libmemcached/ and rsync://m6w6.name::artifacts/libmemcached/.
69 [![Codecov Badge]](https://codecov.io/gh/awesomized/libmemcached)
72 https://codecov.io/gh/awesomized/libmemcached/branch/v1.x/graph/badge.svg
75 Enable the `BUILD_TESTING` setting for a build and run `make test`.
77 cmake -DBUILD_TESTING=ON ../libmemcached
80 ### Continuous integration
82 [![Actions Badge]](https://github.com/awesomized/libmemcached/actions?query=workflow%3Acmake-build-ci)
83 [![Sourcehut Badge]](https://builds.sr.ht/~m6w6/libmemcached)
86 https://github.com/awesomized/libmemcached/workflows/cmake-build-ci/badge.svg?branch=v1.x
89 https://builds.sr.ht/~m6w6/libmemcached/commits.svg
92 CI/Testing is performed on the following system matrix:
94 | OS | Compiler | Arch | Comments |
95 |------------------|------------------------------|-------------------------|----------------------------|
96 | Linux | GNU 7/9/10, Clang 9/10/11/12 | amd64 | sasl, coverage, sanitizers |
97 | MacOS | AppleClang 12 | amd64 | sasl, coverage |
98 | FreeBSD | Clang 11 | amd64 | sasl, coverage |
99 | OpenBSD | Clang 10 | amd64 | sasl, coverage |
100 | Windows | MSVC 16, MinGW | amd64 | no sasl, no tests |
101 | Solaris | SunPro 12.5 | amd64 | no sasl, no tests, manually|
103 libmemcached has been tested against [memcached](https://github.com/memcached/memcached) v1.5 and v1.6.
107 Check out the latest [releases](https://github.com/awesomized/libmemcached/releases)
108 or the bundled [ChangeLog](./ChangeLog-1.1.md) for a comprehensive list of changes.
112 libmemcached is licensed under the 3-Clause-BSD license, which can be
113 found in the accompanying [LICENSE](./LICENSE) file.
117 Please report any issues on the [bug tracker](https://github.com/awesomized/libmemcached/issues).
119 A list of known permanent issues is maintained in [BUGS](./BUGS.md).
121 All forms of contribution are welcome! Please see the bundled
122 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
124 The list of current and past maintainers and contributors is available in [AUTHORS](./AUTHORS).