Skip to content

Commit

Permalink
small header, workflow, and site update
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Sep 19, 2024
1 parent 36ccadd commit 4ac167d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/dox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ jobs:
name: Generate API documentation

runs-on: ubuntu-latest
env:
CC: gcc
XCHANGE: xchange
steps:

- name: install doxygen
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@

A simple, light-weight C/C++ Redis client library.

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

Author: Attila Kovacs

Last Updated: 18 September 2024

## Table of Contents

- [Introduction](#introduction)
Expand Down Expand Up @@ -58,12 +65,6 @@ repository on GitHub.
There are no official releases of __RedisX__ yet. An initial 1.0.0 release is expected in late 2024 or early 2025.
Before then the API may undergo slight changes and tweaks. Use the repository as is at your own risk for now.

Some related links:

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


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

<a name="prerequisites"></a>
Expand Down Expand Up @@ -91,7 +92,8 @@ prior to invoking `make`. The following build variables can be configured:

- `CPPFLAGS`: C pre-processor flags, such as externally defined compiler constants.

- `CFLAGS`: Flags to pass onto the C compiler (default: `-Os -Wall`). Note, `-Iinclude` will be added automatically.
- `CFLAGS`: Flags to pass onto the C compiler (default: `-Os -Wall -std=c99`). Note, `-Iinclude` will be added
automatically.

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

Expand Down
9 changes: 5 additions & 4 deletions include/redisx.h
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,11 @@ enum redisx_channel {
* \sa redisxDestroyRESP()
*/
typedef struct RESP {
char type; ///< value type RESP_ARRAY, RESP_INT ...
int n; ///< Either the integer value of a RESP_INT response, or the dimension of
///< the value field.
void *value; ///< Pointer to text (char *) content to an array of components (RESP**)...
char type; ///< RESP type RESP_ARRAY, RESP_INT ...
int n; ///< Either the integer value of a RESP_INT response, or the
///< dimension of the value field.
void *value; ///< Pointer to text (char *) content or to an array of components
///< (RESP**)...
} RESP;


Expand Down

0 comments on commit 4ac167d

Please sign in to comment.