From 47b07e8c09692624d1dfe7af6fa6d502fcad9d4a Mon Sep 17 00:00:00 2001 From: Satya Das Date: Fri, 25 Oct 2024 10:03:55 +0200 Subject: [PATCH] Improved Readme --- README.md | 2 ++ cppparser/src/README.mdpp | 2 ++ cppwriter/README.md | 11 +++++++++++ 3 files changed, 15 insertions(+) create mode 100644 cppwriter/README.md diff --git a/README.md b/README.md index 7052f5f0..adb34c2e 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,8 @@ TEST_CASE("Parsing hello world program") **This example is a real one and is part of actual unit test of CppParser**. +For AST traversing, see the [CppWriter](cppwriter), that uses the generated AST to create files. + ## Building CppParser ### Get the source diff --git a/cppparser/src/README.mdpp b/cppparser/src/README.mdpp index 67b011f9..b0f5ac07 100644 --- a/cppparser/src/README.mdpp +++ b/cppparser/src/README.mdpp @@ -34,6 +34,8 @@ Below is the program written as unit-test for validating the correctness of gene **This example is a real one and is part of actual unit test of CppParser**. +For AST traversing, see the [CppWriter](cppwriter), that uses the generated AST to create files. + ## Building CppParser ### Get the source diff --git a/cppwriter/README.md b/cppwriter/README.md new file mode 100644 index 00000000..223be2d9 --- /dev/null +++ b/cppwriter/README.md @@ -0,0 +1,11 @@ +# cppwriter + +`cppwriter` is a simple C++ code generation library. + +## Features + +Creates C++ source files (including headers) from `cppast`. +It is mainly used for: + - As an example to show how to traverse the AST generated by the CppParser. + - Testing the CppParser library. +