Skip to content
This repository was archived by the owner on Apr 6, 2019. It is now read-only.

Commit e7c1470

Browse files
committed
rename the main include from cpp_redis.hpp to cpp_redis. update readme.md to documentation installation process.
1 parent d4d9305 commit e7c1470

File tree

4 files changed

+13
-6
lines changed

4 files changed

+13
-6
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,16 @@ cmake .. -DBUILD_TESTS=true -DBUILD_EXAMPLES=true # library, tests and examples
2323
make -j
2424
```
2525

26-
Then, you just have to link the `cpp_redis` library with your project.
26+
If you want to install the library in a specific folder:
2727

28-
For building tests, it is necessary to install `google_tests`. Just run the `install_deps.sh` script which does the work for you.
28+
```bash
29+
cmake -DCMAKE_INSTALL_PREFIX=/destination/path ..
30+
make install -j
31+
```
32+
33+
Then, you just have to include `<cpp_redis/cpp_redis>` in your source files and link the `cpp_redis` library with your project.
34+
35+
To build the tests, it is necessary to install `google_tests`. Just run the `install_deps.sh` script which does the work for you.
2936

3037
## Redis Client
3138
`redis_client` is the class providing communication with a redis server.
@@ -55,7 +62,7 @@ Reply callback is an `std::function<void(reply&)>`.
5562
### Example
5663

5764
```cpp
58-
#include "cpp_redis/cpp_redis.hpp"
65+
#include "cpp_redis/cpp_redis"
5966

6067
#include <signal.h>
6168
#include <iostream>
@@ -126,7 +133,7 @@ Unsubscribe from the given pattern.
126133
### Example
127134
128135
```cpp
129-
#include "cpp_redis/cpp_redis.hpp"
136+
#include "cpp_redis/cpp_redis"
130137
131138
#include <signal.h>
132139
#include <iostream>

examples/redis_client.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#include "cpp_redis/cpp_redis.hpp"
1+
#include <cpp_redis/cpp_redis>
22

33
#include <signal.h>
44
#include <iostream>

examples/redis_subscriber.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#include "cpp_redis/cpp_redis.hpp"
1+
#include <cpp_redis/cpp_redis>
22

33
#include <signal.h>
44
#include <iostream>
File renamed without changes.

0 commit comments

Comments
 (0)