ws
[m6w6/libmemcached] / README.md
1 # libmemcached
2
3 [![Build Status](https://github.com/m6w6/libmemcached/workflows/cmake-build-ci/badge.svg)](https://github.com/m6w6/libmemcached/actions?query=workflow%3Acmake-build-ci)
4 [![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)
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 [Travis CI](https://travis-ci.org/m6w6/libmemcached).
44
45 ## ChangeLog
46
47 Check out the latest [releases](./releases) or the bundled
48 [ChangeLog](./ChangeLog) for a comprehensive list of changes.
49
50 ## License
51
52 libmemcached is licensed under the 3-Clause-BSD license, which can be
53 found in the accompanying [LICENSE](./LICENSE) file.
54
55 ## Contributing
56
57 All forms of contribution are welcome! Please see the bundled
58 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
59
60 The list of past and current contributors is maintained in [THANKS](./THANKS).
61
62 The list of current maintainers is available in [AUTHORS](./AUTHORS).
63
64 ### Building and updating docs
65
66 See [gh-pages/publish](./docs/gh-pages/publish.sh) script, which automates
67 pushing updated documentation to github pages.
68