diff options
author | Kaz Kylheku <kaz@kylheku.com> | 2022-03-23 18:31:35 -0700 |
---|---|---|
committer | Kaz Kylheku <kaz@kylheku.com> | 2022-03-23 18:31:35 -0700 |
commit | 361f4dd7881d0f44c70f29c3ac2ee823b38d1e27 (patch) | |
tree | 8c866c2929593c1d036477e410afd7a09a696ed7 /README.md | |
parent | 4f5117aaa411d7fae8b7133a3089ae8e3e158d07 (diff) | |
download | cppawk-361f4dd7881d0f44c70f29c3ac2ee823b38d1e27.tar.gz cppawk-361f4dd7881d0f44c70f29c3ac2ee823b38d1e27.tar.bz2 cppawk-361f4dd7881d0f44c70f29c3ac2ee823b38d1e27.zip |
README: Roadmap section.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 17 insertions, 2 deletions
@@ -5,8 +5,7 @@ the C preprocessor (GNU `cpp`) on the Awk code and calls `gawk`. `cppawk` understands the basic Awk options like `-F` and `-v`, and also understand common `cpp` options like `-I` and `-Dmacro=value`. - -There is a `man` page with all the details. +The `cppawk` `man` page has the invocation and usage details. For instance, if we define a file called `awkloop.h` which has these contents @@ -35,6 +34,22 @@ Then this sort of code is possible: We have implemented a facsimile of an Awk input scanning loop inside a function with a bit of syntactic sugar. +## Roadmap + +`cppawk` is been carefully developed, and has a regression test suite. +Nearly every feature and fix was developed by first writing one or more +failing tests and getting them to pass. The script is stable and nearly +feature-complete, since it is out of the project scope to modify Awk +or the C preprocessor. The remaining work is likely solving portability +issues, like using with different implementations of the C preprocessor. + +Among future directions for `cppawk` is the development of a small +library of useful standard headers. The foundation has been laid for +this because when `#include <...>` is used (angle bracket include), it looks in +a subdirectory called `cppawk-include` which is in the same directory as +itself. For instance if `cppawk` is `/usr/bin/cppawk`, it looks in +`/usr/bin/cppawk-include`. This library directory is currently empty. + ## Why? * Why not? |