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