Skip to content

Commit

Permalink
Small 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 1279262 commit 02edb33
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ jobs:
- name: Build xchange dependency
run: make -C xchange shared

- name: Build xchange dependency
- name: Build RedisX dependency
run: make -C redisx shared

- name: Build shared library
Expand Down
4 changes: 0 additions & 4 deletions .github/workflows/dox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,6 @@ jobs:
name: Generate API documentation

runs-on: ubuntu-latest
env:
CC: gcc
XCHANGE: xchange
REDISX: redisx
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 @@ -14,11 +14,16 @@
</picture>
<br clear="all">

# SMA-X: SMA information exchange
# smax-clib

C/C++ client library for the SMA Exchange (SMA-X) structured real-time database

- [API documentation](https://smithsonian.github.io/smax-clib/apidoc/html/files.html)
- [Project pages](https://smithsonian.github.io/smax-clib) on github.io

Author: Attila Kovacs

Last Updated: 14 September 2024
Last Updated: 18 September 2024

## Table of Contents

Expand Down Expand Up @@ -55,11 +60,7 @@ for C/C++ (C99) and Python 3. We may provide Java and/or Rust client libraries t
There are no official releases of __smax-clib__ yet. An initial 1.0.0 release is expected early/mid 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/smax-clib/apidoc/html/files.html)
- [SMA-X specification](https://docs.google.com/document/d/1eYbWDClKkV7JnJxv4MxuNBNV47dFXuUWu7C4Ve_YTf0/edit?usp=sharing)
- [Project page](https://smithsonian.github.io/smax-clib) on github.io
- [Smithsonian/smax-python](https://smithsonian.github.io/smax-python) an alternative library for Python 3.


Expand Down Expand Up @@ -101,7 +102,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, `-lredisx -lxchange` will be added automatically.

Expand Down

0 comments on commit 02edb33

Please sign in to comment.