Add example/README.md

This commit is contained in:
Nigel Tao committed 2020-04-12 21:13:42 +10:00
1 parent 4bc42db1d3
commit 623811086f
2 files changed
+13 -1

No files matched your search

+11
View File
@@ -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.
+2 -1
View File
@@ -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