xref: /aosp_15_r20/external/wuffs-mirror-release-c/release/c/README.md (revision 30889fd3ad667d11ca7a90e9af352e217875dd23)
1*30889fd3SAndroid Build Coastguard Worker# Releases (in the C Programming Language)
2*30889fd3SAndroid Build Coastguard Worker
3*30889fd3SAndroid Build Coastguard Worker[Wuffs the Library](/doc/wuffs-the-library.md) ships as a "single file C
4*30889fd3SAndroid Build Coastguard Workerlibrary", also known as a "[header file
5*30889fd3SAndroid Build Coastguard Workerlibrary](https://github.com/nothings/stb/blob/master/docs/stb_howto.txt)".
6*30889fd3SAndroid Build Coastguard Worker
7*30889fd3SAndroid Build Coastguard WorkerTo use that library in your C/C++ project, you just need to copy one file from
8*30889fd3SAndroid Build Coastguard Workerthis directory, or otherwise integrate that one file into your build system.
9*30889fd3SAndroid Build Coastguard WorkerTypically, pick the latest stable version (but not the unsupported snapshot),
10*30889fd3SAndroid Build Coastguard Workerwith a filename like `wuffs-vMAJOR.MINOR.c` for version MAJOR.MINOR.
11*30889fd3SAndroid Build Coastguard Worker
12*30889fd3SAndroid Build Coastguard WorkerTo use that single file as a "foo.c"-like implementation, instead of a
13*30889fd3SAndroid Build Coastguard Worker"foo.h"-like header, `#define WUFFS_IMPLEMENTATION` before `#include`'ing or
14*30889fd3SAndroid Build Coastguard Workercompiling it.
15*30889fd3SAndroid Build Coastguard Worker
16*30889fd3SAndroid Build Coastguard Worker
17*30889fd3SAndroid Build Coastguard Worker# Latest Stable Version
18*30889fd3SAndroid Build Coastguard Worker
19*30889fd3SAndroid Build Coastguard Worker**Version 0.2 (December 2019)** is the latest stable version. Stable means that
20*30889fd3SAndroid Build Coastguard Workerits API won't change any further, but being a "version 0.x" means that:
21*30889fd3SAndroid Build Coastguard Worker
22*30889fd3SAndroid Build Coastguard Worker- It will not have long term support.
23*30889fd3SAndroid Build Coastguard Worker- Newer versions make no promises about compatibility.
24*30889fd3SAndroid Build Coastguard Worker
25*30889fd3SAndroid Build Coastguard Worker
26*30889fd3SAndroid Build Coastguard Worker# Mirror
27*30889fd3SAndroid Build Coastguard Worker
28*30889fd3SAndroid Build Coastguard WorkerWuffs' canonical repository is located at
29*30889fd3SAndroid Build Coastguard Worker[github.com/google/wuffs](https://github.com/google/wuffs). If you just want to
30*30889fd3SAndroid Build Coastguard Worker*use* Wuffs-the-library in its C form (instead of *modifying* its Wuffs form or
31*30889fd3SAndroid Build Coastguard Workerotherwise needing Wuffs-the-language tools), a mirror of just the `release/c`
32*30889fd3SAndroid Build Coastguard Workerdirectory is located at
33*30889fd3SAndroid Build Coastguard Worker[github.com/google/wuffs-mirror-release-c](https://github.com/google/wuffs-mirror-release-c).
34*30889fd3SAndroid Build Coastguard WorkerBy excluding everything else, the mirror is much smaller than and changes much
35*30889fd3SAndroid Build Coastguard Workerless frequently than the canonical repository.
36