From 9e8eba6ec3f90d4fae09e72d4d82299c9b6e0ce6 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Sat, 21 Jul 2018 09:28:48 +1000 Subject: [PATCH] Add release/c/README.md --- release/c/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 release/c/README.md diff --git a/release/c/README.md b/release/c/README.md new file mode 100644 index 00000000..84db49cd --- /dev/null +++ b/release/c/README.md @@ -0,0 +1,11 @@ +Wuffs ships as a "single file C library", also known as a "[header file +library](https://github.com/nothings/stb/blob/master/docs/stb_howto.txt)". + +To use Wuffs in your C/C++ project, you just need to copy one file from this +directory, or otherwise integrate that one file into your build system. +Typically, pick the latest version (but not the unsupported snapshot), with a +filename like `wuffs-vMAJOR.MINOR.h` for version MAJOR.MINOR. + +To use that single file as a "foo.c"-like implementation, instead of a +"foo.h"-like header, `#define WUFFS_IMPLEMENTATION` before `#include`'ing or +compiling it.