From 623811086ff3e97d46c6d826fa844a3db2b44873 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Sun, 12 Apr 2020 21:13:42 +1000 Subject: [PATCH] Add example/README.md --- example/README.md | 11 +++++++++++ hello-wuffs-c/README.md | 3 ++- 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 example/README.md diff --git a/example/README.md b/example/README.md new file mode 100644 index 00000000..2988b448 --- /dev/null +++ b/example/README.md @@ -0,0 +1,11 @@ +This directory contains example programs that use [Wuffs the +Library](/doc/wuffs-the-library.md). See [Hello `wuffs-c`](/hello-wuffs-c) for +an example program that uses [Wuffs the Language](/doc/wuffs-the-language.md) +and its `wuffs-c` compiler. + +Other than [example/library](/example/library/library.c), all of these programs +do real work. They're not just programming language toys at the "calculate the +Fibonacci sequence" level of triviality. For example, the +[example/crc32](/example/crc32/crc32.cc) and +[example/zcat](/example/zcat/zcat.c) programs are roughly equivalent to Debian +Linux's `/usr/bin/crc32` and `/bin/zcat` programs. diff --git a/hello-wuffs-c/README.md b/hello-wuffs-c/README.md index 1fb6cf87..60b2996a 100644 --- a/hello-wuffs-c/README.md +++ b/hello-wuffs-c/README.md @@ -153,7 +153,8 @@ For more realistic problem domains, the output often isn't just a single That's the end of this "Hello world"-ish introduction. After that, you can read more documentation about both [Wuffs the Language](/doc/wuffs-the-language.md) -and [Wuffs the Library](/doc/wuffs-the-library.md). +and [Wuffs the Library](/doc/wuffs-the-library.md) (which links to more example +programs). Finally, there are admittedly a couple of TODOs in this directory, concerning some rough edges in what should be a simple example. Version 0.2 (December