Signed-off-by: mmazas <mmazas@ITEM-S104678.emea.msad.sopra>

Author: mmazas

LICENSE

@@ -13,7 +13,7 @@ modification, are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
-    * Neither the names of of the copyright holders nor the names of its
+    * Neither the names of the copyright holders nor the names of its
       contributors may be used to endorse or promote products derived from
       this software without specific prior written permission.
 

README.md

@@ -1,5 +1,7 @@
 # JavaCC-8 C++ (CPP)
 
-This is the JavaCC **C++** generator Git repository / java & maven project of JavaCC version 8.
+This is the JavaCC **C++** generator Git repository / Java & Maven project of JavaCC version 8.
 
-See the README at [javacc-8](https://github.com/javacc/javacc-8)
+For an end user view of JavaCC, see the **README.md** at [javacc-8](https://github.com/javacc/javacc-8).
+
+For a technical view of the different projects of JavaCC v8, see the **README_BUILD.md** at [javacc-8/README_BUILD.md](https://github.com/javacc/javacc-8/README_BUILD.md)

examples/CORBA-IDL/README

@@ -0,0 +1,11 @@
+This directory contains an CORBA 2.0 grammar for [IDL](src/main/java/IDL.jj).
+
+It parses an input file and just outputs a success or failure message.
+
+Build it in the usual manner with [pom.xml](pom.xml):
+
+- Maven:
+
+```
+  mvn clean verify
+```

examples/CORBA-IDL/README.md

@@ -0,0 +1,5 @@
+In this directory lie the legacy examples, with their build and test files,  
+targeted to explain some aspects of the JavaCC/JJTree grammar;  
+they are considered as a subset of integration tests.
+
+Some examples have been ported from Java to C++ and C#, with the goal to be fully equivalent.

examples/README.md

@@ -0,0 +1,6 @@
+In this directory lie some grammars shared by contributors, with their build files;  
+feel free to enhance them and share them back.
+
+They are considered as a subset of integration tests (they should at least generate properly).
+
+Some examples have been ported between Java and C++ and C#, with the goal to be fully equivalent.

grammars/README.md

@@ -0,0 +1,22 @@
+In this directory lie small grammars, with their build and test files,  
+targeted to exercise some aspects of parsing and code generation;  
+they are considered as a subset of integration tests.
+
+- **basnn**: *bas* stands for sandbox (FR *bac à sable*) very small grammars to exercise some basic tests
+
+- **issue-7-#n**: related to issue #n in [v7 repo](https://github.com/javacc/javacc/issues)
+
+- **issue-8-#n**: related to issue #n in [v8 parent repo](https://github.com/javacc/javacc-8/issues)
+
+- **issue-co-#n**: related to issue #n in [v8 Core repo](https://github.com/javacc/javacc-8-core/issues)
+
+- **issue-ja-#n**: related to issue #n in [v8 Java repo](https://github.com/javacc/javacc-8-java/issues)
+
+- **issue-cp-#n**: related to issue #n in [v8 C++ repo](https://github.com/javacc/javacc-8-cpp/issues)
+
+- **issue-cs-#n**: related to issue #n in [v8 C# repo](https://github.com/javacc/javacc-8-csharp/issues)
+
+People may have opened issues in some repo but they may be tested in a different repo,  
+so the naming convention to help refer them easily.
+
+Some bas and issues have been ported from Java to C++ and C#, with the goal to be fully equivalent.