From c5c44e3b7134f62a4207a6c957acaec79430fa86 Mon Sep 17 00:00:00 2001 From: Attila Kovacs Date: Tue, 14 Jan 2025 11:14:28 +0100 Subject: [PATCH] README: more uniquely named anchors and site update --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index a8e5814..1476635 100644 --- a/README.md +++ b/README.md @@ -30,26 +30,26 @@ Last Updated: 18 September 2024 ## Table of Contents - - [Introduction](#introduction) - - [Prerequisites](#prerequisites) - - [Building the SMA-X C library](#building) - - [Linking your application against `smax-clib`](#linking) + - [Introduction](#smax-introduction) + - [Prerequisites](#smax-prerequisites) + - [Building the SMA-X C library](#building-smax) + - [Linking your application against `smax-clib`](#smax-linking) - [Command-line tools](#command-line-tools) - - [Initial configuration](#configuration) - - [Connecting to / disconnecting from SMA-X](#connecting) + - [Initial configuration](#smax-configuration) + - [Connecting to / disconnecting from SMA-X](#smax-connecting) - [Sharing and pulling data](#sharing-and-pulling) - [Lazy pulling (high-frequency queries)](#lazy-pulling) - [Pipelined pulls (high volume queries)](#pipelined-pulls) - [Custom update handling](#update-handling) - [Program status / error messages via SMA-X](#status-messages) - [Optional metadata](#optional-metadata) - - [Error handling](#error-handling) - - [Debug support](#debug-support) - - [Future plans](#future-plans) + - [Error handling](#smax-error-handling) + - [Debug support](#smax-debug-support) + - [Future plans](#smax-future-plans) ------------------------------------------------------------------------------ - + ## Introduction The [SMA Exchange (SMA-X)](https://docs.google.com/document/d/1eYbWDClKkV7JnJxv4MxuNBNV47dFXuUWu7C4Ve_YTf0/edit?usp=sharing) @@ -77,7 +77,7 @@ Before then the API may undergo slight changes and tweaks. Use the repository as ------------------------------------------------------------------------------ - + ## Prerequisites The SMA-X C/C++ library has a build and runtime dependency on the __xchange__ and __RedisX__ libraries also available @@ -92,7 +92,7 @@ Additionally, to configure your Redis (or Valkey / Dragonfly) servers for SMA-X, ------------------------------------------------------------------------------ - + ## Building the SMA-X C library The __smax-clib__ library can be built either as a shared (`libsmax.so[.1]`) and as a static (`libsmax.a`) library, @@ -158,7 +158,7 @@ Or, to stage the installation (to `/usr`) under a 'build root': ----------------------------------------------------------------------------- - + ## Linking your application against `smax-clib` Provided you have installed the shared (`libsmax.so`, `libredisx.so`, and `libxchange.so`) or static (`libsmax.a`, @@ -198,7 +198,7 @@ as `bash`, or `perl` (also `python` though we recommend to use the native ------------------------------------------------------------------------------ - + ## Initial configuration Bu default, the library assumes that the Redis server used for SMA-X runs on a machine called `smax` (e.g. you may assign @@ -297,7 +297,7 @@ the current configuration. ------------------------------------------------------------------------------ - + ## Connecting to / disconnecting from SMA-X Once you have configured the connection parameters, you can connect to the server by: @@ -316,7 +316,7 @@ And, when you are done, you should disconnect with: smaxDisconnect(); ``` - + ### Connection / disconnection hooks The user of the __smax-clib__ library might want to know when connections to the SMA-X server are established, or when @@ -347,14 +347,14 @@ The same goes for disconnect hooks, using `smaxAddDisconnectHook()` instead. ## Sharing and pulling data - - [The basics](#basics) + - [The basics](#smax-basics) - [Standard metadata](#metadata) - [Flexible types and sizes](#flexible-types-and-sizes) - [Scalar quantities](#scalars) - [Arrays](#arrays) - [Structures / substructures](#structures) - + ### The basics For SMA-X we use the terms sharing and pulling, instead of the more generic get/set terminology. The intention is to @@ -1047,7 +1047,7 @@ passing its ID number (<0) to `smaxRemoveMessageProcessor()`. ----------------------------------------------------------------------------- - + ## Error handling The principal error handling of the library is an extension of that of __xchange__, with further error codes defined @@ -1065,7 +1065,7 @@ by a pointer argument), can be inspected by `smaxErrorDescription()`, e.g.: ----------------------------------------------------------------------------- - + ## Debug support You can enable verbose output of the library with `smaxSetVerbose(boolean)`. When enabled, it will produce status @@ -1085,7 +1085,7 @@ settings. ----------------------------------------------------------------------------- - + ## Future plans Some obvious ways the library could evolve and grow in the not too distant future: