aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2022-04-20 07:46:16 -0700
committerKaz Kylheku <kaz@kylheku.com>2022-04-20 07:46:16 -0700
commit3334ef7fc25ce04647f12a3a887637e1bb6aec17 (patch)
treefc4f57f2af22084156aff92e324f82937fb3a535
parent2872754c1090cff9f0be6ba61d350b65cdeaee85 (diff)
downloadcppawk-3334ef7fc25ce04647f12a3a887637e1bb6aec17.tar.gz
cppawk-3334ef7fc25ce04647f12a3a887637e1bb6aec17.tar.bz2
cppawk-3334ef7fc25ce04647f12a3a887637e1bb6aec17.zip
README: turn header names into links.
-rw-r--r--README.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/README.md b/README.md
index 3a4b02e..a77e366 100644
--- a/README.md
+++ b/README.md
@@ -119,32 +119,30 @@ itself. For instance if `cppawk` is `/usr/bin/cppawk`, it looks in
There are currently
-* `<case.h>`: provides a portable `case` statement macro which
+* [`<case.h>`](../tree/cppawk-case.1): provides a portable
+ `case` statement macro which
efficiently translates to a GNU Awk `switch` statement or else to less
efficient but portable code. Additionally, the `case` statement requires
clauses to be explicit about whether they fall through or break, which
makes it safer to use.
- Documented by the [`cppawk-case` man page](../tree/cppawk-case.1).
-* `<narg.h>`: provides useful primitives for easily writing variadic macros.
- Documented by the [`cppawk-narg` man page](../tree/cppawk-narg.1).
+* [`<narg.h>`](../tree/cppawk-narg.1): provides useful primitives for easily
+ writing variadic macros.
-* `<iter.h>`: provides powerful iteration constructs, including a `loop`
+* [`<iter.h>`](../tree/cppawk-iter.1): provides powerful iteration
+ constructs, including a `loop`
macro that features the ability for the application to define
new iteration clauses, in addition to the numerous useful ones that
come with `loop`.
- Documented by the [`cppawk-iter` man page](../tree/cppawk-iter.1).
-* `<cons.h>`: provides Lisp-like functional, heterogeneous list manipulation,
+* [`<cons.h>`](../tree/cppawk-cons.1): provides Lisp-like functional, heterogeneous list manipulation,
higher order functions, some useful control operators, and functions
combining Lisp lists and Awk arrays such as `group_by`.
- Documented by the [`cppawk-cons` man page](../tree/cppawk-cons.1).
-* `<fun.h>`: three macros for indirect functions, with a simple
- partial application mechanism for binding the leftmost argument.
- This requires GNU Awk 4.0 or higher, which features indirect
+* [`<fun.h>`](../tree/cppawk-fun.1): three macros for indirect functions,
+ with a simple partial application mechanism for binding the leftmost
+ argument. This requires GNU Awk 4.0 or higher, which features indirect
function calls. Note: there are bugs in GNU Awk's indirect function
calls feature that are present right through 5.1.1.
- Documented by the [`cppawk-fun` man page](../tree/cppawk-fun.1).
Several unreleased headers are in the development queue: