Skip to content

Commit

Permalink
README edits and site update
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Sep 5, 2024
1 parent 355f739 commit 342baf0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Some related links:

- [API documentation](https://smithsonian.github.io/redisx/apidoc/html/files.html)
- [Project page](https://smithsonian.github.io/redisx) on github.io
- [xchange](https://smithsonian.github.io/redisx) library dependency


-----------------------------------------------------------------------------
Expand All @@ -76,8 +77,8 @@ RedisX.
<a name="building-redisx"></a>
## Building RedisX

The RedisX library can be built either as a shared (`libredisx.so[.1]`) and as a static (`libredisx.a`) library,
depending on what suites your needs best.
The __RedisX__ library can be built either as a shared (`libredisx.so[.1]`) and as a static (`libredisx.a`) library,
depending on what suits your needs best.

You can configure the build, either by editing `config.mk` or else by defining the relevant environment variables
prior to invoking `make`. The following build variables can be configured:
Expand All @@ -94,10 +95,14 @@ prior to invoking `make`. The following build variables can be configured:

- `LDFLAGS`: Linker flags (default is `-lm`). Note, `-lxchange` will be added automatically.

- `BUILD_MODE`: You can set it to `debug` to enable debugging features: it will initialize the global `xDebug`
variable to `TRUE`) and add `-g` to `CFLAGS`.

- `CHECKEXTRA`: Extra options to pass to `cppcheck` for the `make check` target

After configuring, you can simply run `make`, which will build the `shared` (`lib/libxchange.so[.1]`) and `static`
(`lib/libxchange.a`) libraries, local HTML documentation (provided `doxygen` is available), and performs static

After configuring, you can simply run `make`, which will build the `shared` (`lib/libredisx.so[.1]`) and `static`
(`lib/libredisx.a`) libraries, local HTML documentation (provided `doxygen` is available), and performs static
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).

Expand Down
2 changes: 1 addition & 1 deletion config.mk
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ CHECKOPTS += --template='{file}({line}): {severity} ({id}): {message}' --inline-

# Compiler and linker options etc.
ifeq ($(BUILD_MODE),debug)
CFLAGS += -g
CFLAGS += -g -DDEBUG
endif

# Search for files in the designated locations
Expand Down

0 comments on commit 342baf0

Please sign in to comment.