Improved Readme

satya-das · Oct 25, 2024 · 47b07e8 · 47b07e8
1 parent 484d8ca
commit 47b07e8
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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.
+