Skip to content

Commit

Permalink
chore: add README for s4c-animate folder
Browse files Browse the repository at this point in the history
  • Loading branch information
jgabaut committed Aug 29, 2024
1 parent c4e5bc1 commit 52bb5e5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 5 deletions.
25 changes: 25 additions & 0 deletions s4c-animate/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# s4c-animate

Before `0.4.8`, this module was the main library in this repo. Now, it's been absorbed into `src/s4c.h`.

In the upcoming `0.5` release, this temporary stub file will be removed.

All previous APIs will still be available in the new module, but some macros may be renamed to better namespace the new module.

A list of all updated identifiers follows.


```c
S4C_MAJOR // Dropped
S4C_MINOR // Dropped
S4C_PATCH // Dropped
S4C_VERSION // Renamed to S4C_ANIMATE_VERSION
S4C_MAJOR_VERSION // Renamed to S4C_ANIMATE_MAJOR_VERSION
S4C_MINOR_VERSION // Renamed to S4C_ANIMATE_MINOR_VERSION
S4C_PATCH_VERSION // Renamed to S4C_ANIMATE_PATCH_VERSION
int_s4c_version() // Renamed to int_s4c_animate_version()
s4c_printVersionToFile() // Renamed to s4c_animate_printVersionToFile()
s4c_echoVersionToFile() // Renamed to s4c_animate_echoVersionToFile()
S4C_ECHOVERSION() // Renamed to S4C_ANIMATE_ECHOVERSION()
S4C_PRINTVERSION() // Renamed to S4C_ANIMATE_PRINTVERSION()
```
6 changes: 1 addition & 5 deletions s4c-animate/animate.h
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,11 @@
#define S4C_ANIMATE_MINOR_VERSION 4
#define S4C_ANIMATE_PATCH_VERSION 8

#define S4C_MAJOR S4C_ANIMATE_MAJOR_VERSION
#define S4C_MINOR S4C_ANIMATE_MINOR_VERSION
#define S4C_PATCH S4C_ANIMATE_PATCH_VERSION

/**
* Defines current API version number from S4C_{MAJOR,MINOR,PATCH}.
*/
static const int S4C_ANIMATE_API_VERSION_INT =
(S4C_MAJOR * 1000000 + S4C_MINOR * 10000 + S4C_PATCH * 100);
(S4C_ANIMATE_MAJOR_VERSION * 1000000 + S4C_ANIMATE_MINOR_VERSION * 10000 + S4C_ANIMATE_PATCH_VERSION * 100);
/**< Represents current version with numeric format.*/

/**
Expand Down

0 comments on commit 52bb5e5

Please sign in to comment.