Skip to content

Commit

Permalink
README edit and site update
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Oct 10, 2024
1 parent 53b3405 commit 2a57421
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Last Updated: 18 September 2024
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Building RedisX](#building-redisx)
- [Linking your application against RedisX](#linking)
- [Managing Redis server connections](#managing-redis-server-connections)
- [Simple Redis queries](#simple-redis-queries)
- [Accessing key / value data](#accessing-key-value-data)
Expand Down Expand Up @@ -118,6 +119,24 @@ After configuring, you can simply run `make`, which will build the `shared` (`li
analysis via the `check` target. Or, you may build just the components you are interested in, by specifying the
desired `make` target(s). (You can use `make help` to get a summary of the available `make` targets).

-----------------------------------------------------------------------------

<a name="linking"></a>
## Linking your application against RedisX

Provided you have installed the shared (`libredisx.so` and `libxchange.so`) or static (`libredisx.a` and
`libxchange.so`) libraries in a location that is in your `LD_LIBRARY_PATH` (e.g. in `/usr/lib` or `/usr/local/lib`)
you can simply link your program using the `-lredisx -lxchange` flags. Your `Makefile` may look like:

```make
myprog: ...
cc -o $@ $^ $(LDFLAGS) -lredisx -lxchange
```

(Or, you might simply add `-lredisx -lxchange` to `LDFLAGS` and use a more standard recipe.) And, in if you installed
the __RedisX__ and/or __xchange__ libraries elsewhere, you can simply add their location(s) to `LD_LIBRARY_PATH` prior
to linking.


-----------------------------------------------------------------------------

Expand Down

0 comments on commit 2a57421

Please sign in to comment.