xref: /aosp_15_r20/external/wuffs-mirror-release-c/README.md (revision 30889fd3ad667d11ca7a90e9af352e217875dd23)
1*30889fd3SAndroid Build Coastguard Worker# Wuffs Mirror (release/c)
2*30889fd3SAndroid Build Coastguard Worker
3*30889fd3SAndroid Build Coastguard WorkerThis repository mirrors a subset of the
4*30889fd3SAndroid Build Coastguard Worker[Wuffs](https://github.com/google/wuffs) (Wrangling Untrusted File Formats
5*30889fd3SAndroid Build Coastguard WorkerSafely) repository.
6*30889fd3SAndroid Build Coastguard Worker
7*30889fd3SAndroid Build Coastguard WorkerWuffs is both a programming language (Wuffs-the-language) and a standard
8*30889fd3SAndroid Build Coastguard Workerlibrary (Wuffs-the-library) written in that language. The Wuffs toolchain
9*30889fd3SAndroid Build Coastguard Workerconverts from Wuffs-the-language to C and Wuffs-the-library is available as a
10*30889fd3SAndroid Build Coastguard Workersingle C file - a [header file
11*30889fd3SAndroid Build Coastguard Workerlibrary](https://github.com/nothings/stb/blob/master/docs/stb_howto.txt).
12*30889fd3SAndroid Build Coastguard Worker
13*30889fd3SAndroid Build Coastguard WorkerPeople who just want to *use* Wuffs-the-library in its C form (instead of
14*30889fd3SAndroid Build Coastguard Worker*modifying* its Wuffs form or otherwise needing Wuffs-the-language tools) only
15*30889fd3SAndroid Build Coastguard Workerneed that one C file.
16*30889fd3SAndroid Build Coastguard Worker
17*30889fd3SAndroid Build Coastguard WorkerThis repository's [`release/c`](./release/c) directory contains that C file (at
18*30889fd3SAndroid Build Coastguard Workervarious versions). It mirrors the `release/c` directory of the [original Wuffs
19*30889fd3SAndroid Build Coastguard Workerrepository](https://github.com/google/wuffs) (except for the "unsupported
20*30889fd3SAndroid Build Coastguard Workersnapshot" version). By excluding everything else, this repository is much
21*30889fd3SAndroid Build Coastguard Workersmaller and changes much less frequently.
22*30889fd3SAndroid Build Coastguard Worker
23*30889fd3SAndroid Build Coastguard Worker
24*30889fd3SAndroid Build Coastguard Worker## Updates
25*30889fd3SAndroid Build Coastguard Worker
26*30889fd3SAndroid Build Coastguard WorkerThis repository's `release/c` directory is manually updated by the
27*30889fd3SAndroid Build Coastguard Worker`script/sync.sh` shell script, which also logs to [`sync.txt`](./sync.txt).
28*30889fd3SAndroid Build Coastguard Worker
29*30889fd3SAndroid Build Coastguard Worker
30*30889fd3SAndroid Build Coastguard Worker## Disclaimer
31*30889fd3SAndroid Build Coastguard Worker
32*30889fd3SAndroid Build Coastguard WorkerThis is not an official Google product, it is just code that happens to be
33*30889fd3SAndroid Build Coastguard Workerowned by Google.
34*30889fd3SAndroid Build Coastguard Worker
35*30889fd3SAndroid Build Coastguard Worker
36*30889fd3SAndroid Build Coastguard Worker---
37*30889fd3SAndroid Build Coastguard Worker
38*30889fd3SAndroid Build Coastguard WorkerUpdated on March 2021.
39