Merge pull request #10 from CodeIntelligenceTesting/fix-readme

refactor: update README.md files for example projects

Author: mlsandnerCI

example-projects/advanced-setup/bazel/README.md

@@ -1,10 +1,12 @@
 ## Project Description
 
-This is an extended example Bazel project with multiple packages and
-two fuzztests `main/tests:explore_me_fuzz_test` and `fuzztests:test_me_fuzz_test`.
+This is a Bazel project configured with **cifuzz** which includes:
 
-The `explore_me_fuzz_test` is defined in the same package as the source
-code and `test_me_fuzz_test` is located in a separated package.
+- multiple packages
+- two Fuzz Tests
+  - `main/tests:explore_me_fuzz_test`, defined in the same package as the source
+    code
+  - `fuzztests:test_me_fuzz_test`, located in a separated package
 
 ## Run
 
@@ -28,7 +30,8 @@ cifuzz run fuzztests:test_me_fuzz_test
 cifuzz bundle main/tests:explore_me_fuzz_test
 ```
 
-Should include one fuzz test with two targets to cover fuzzing and coverage builds.
+The bundle should include **1** Fuzz Test with **2** targets to cover fuzzing 
+and coverage builds:
 
 ```
 ...
@@ -45,7 +48,8 @@ path: replayer/coverage/main/tests/explore_me_fuzz_test/bin/explore_me_fuzz_test
 cifuzz bundle
 ```
 
-Should include one fuzz test with two targets to cover fuzzing and coverage builds.
+The bundle should include **1** Fuzz Test with **2** targets to cover fuzzing 
+and coverage builds:
 
 ```
 ...

example-projects/advanced-setup/cmake/README.md

@@ -1,7 +1,11 @@
 ## Project Description
 
-This is an extended example CMake project which includes two fuzz tests
-`test_me_fuzztest`and `explore_me_fuzztest` in a multiple package setup.
+This is a CMake project configured with **cifuzz* which includes:
+
+- multiple packages
+- two Fuzz Tests
+  - `test_me_fuzztest`
+  - `explore_me_fuzztest` 
 
 ## Run
 
@@ -23,8 +27,8 @@ cifuzz run test_me_fuzztest
 cifuzz bundle
 ```
 
-Should include both fuzz tests with four targets in total to cover
-fuzzing and coverage builds.
+The bundle should include **2** Fuzz Tests with **4** targets in total to cover
+fuzzing and coverage builds:
 
 ```
 ...

example-projects/advanced-setup/gradle/README.md

@@ -1,12 +1,11 @@
 ## Project Description
 
-This is an extended example gradle project which covers custom project setups:
+This is a Gradle project configured with **cifuzz** which includes:
 
-- multiple fuzz tests in one class
-- mixed unit and fuzz tests in one class
+- class with multiple Fuzz Tests
+- class with mixed Unit and Fuzz Tests
 - changed source directory for test source set
 - multi-project layout
-- more than one fuzzable class (with different findings)
 
 ## Run
 
@@ -38,7 +37,7 @@ cifuzz run -C testsuite com.example.RCEFuzzTestCase::fuzzTestDontTrigger
 cifuzz -C app bundle
 ```
 
-Should include **1** fuzz test
+The bundle should include **1** Fuzz Test:
 
 - `com.example.TestCases::remoteCodeFuzzTest`
 
@@ -48,7 +47,7 @@ Should include **1** fuzz test
 cifuzz -C testsuite bundle
 ```
 
-Should include **3** fuzz tests
+The bundle should include **3** Fuzz Tests:
 
 - `com.example.OutOfBoundsTestCase::fuzzTest`
 - `com.example.RCEFuzzTestCase::fuzzTestTrigger`

example-projects/advanced-setup/maven/README.md

@@ -1,19 +1,16 @@
 ## Project Description
 
-This is an extended example maven project which covers custom project setups:
+This is an Maven project configured with **cifuzz** which includes:
 
-- multiple fuzz tests in one class
-- mixed unit and fuzz tests in one class
+- class with multiple Fuzz Tests
+- class with mixed Unit and Fuzz Tests
 - changed source directory for test source set
 - multi-project layout
-- more than one fuzzable class (with different findings)
-
-Right now we do not support a multi module project setup with maven so this project has two `cifuzz.yaml`,
-one in the module `tests` and one in `util`.
 
 ## Setup
 
-To run the fuzz tests, the Maven `install` command needs to be run to be able to resolve all dependencies.
+To run the fuzz tests, the Maven `install` command needs to be called to be able 
+to resolve all dependencies.
 
 ```
 mvn -Dmaven.test.skip=true install
@@ -44,7 +41,7 @@ cifuzz -C tests run NegativeArraySizeFuzzTest::fuzzTest
 cifuzz -C tests bundle
 ```
 
-Should include **2** fuzz tests
+The bundle should include **2** Fuzz Tests:
 
 - `NegativeArraySizeFuzzTest::fuzzTest`
 - `UtilFuzzTest::fuzzTest`
@@ -55,6 +52,6 @@ Should include **2** fuzz tests
 cifuzz -C util bundle
 ```
 
-Should include **1** fuzz test
+The bundle should include **1** Fuzz Test:
 
 - `util.UtilTest::joinFuzzTest`

example-projects/advanced-setup/other/README.md

@@ -1,9 +1,12 @@
 ## Project Description
 
-This is an extended example project categorized under build system "other".
-It includes two fuzz tests
-`main/tests/explore_me_fuzztest` and `fuzztests/test_me_fuzztest` in a multiple package
-setup and one corresponding Makefile.
+This is a C++ Make project configured with **cifuzz**, which includes:
+
+- multiple packages
+- one Makefile
+- two Fuzz Tests
+  - `main/tests/explore_me_fuzztest` 
+  - `fuzztests/test_me_fuzztest` 
 
 ## Run
 
@@ -27,7 +30,8 @@ cifuzz run fuzztests/test_me_fuzztest
 cifuzz bundle main/tests/explore_me_fuzztest
 ```
 
-Should include the fuzz test with two targets to cover fuzzing and coverage builds.
+The bundle hould include **1** Fuzz Test with **2** targets to cover fuzzing and 
+coverage builds:
 
 ```
 ...

example-projects/simple-setup/bazel/README.md

@@ -1,18 +1,19 @@
-# cifuzz bazel example
+## Project Description
 
-This is a simple bazel based project, already configured with
-**cifuzz**. It should quickly produce a finding, but slow enough to
-see the progress of the fuzzer.
+This is a simple Bazel project configured with **cifuzz** and has
+one Fuzz Test.
 
-You can start the fuzzing with
+## Run
 
 ```bash
-cifuzz run //src:explore_me_fuzz_test
+cifuzz run src:explore_me_fuzz_test
 ```
 
+The Fuzz Test should trigger a Heap Buffer Overflow.
+
 ## Create regression test
 
-After you have discovered a finding, you may want to include this as
+After you have discovered a Finding, you may want to include this as
 part of a regression test. To replay findings from the
 `src/explore_me_fuzz_test_inputs` directory:
 

example-projects/simple-setup/cmake/README.md

@@ -1,20 +1,21 @@
-# cifuzz CMake example
+## Project Description
 
-This is a simple CMake based project, already configured with
-**cifuzz**. It should quickly produce a finding, but slow enough to
-see the progress of the fuzzer.
+This is a simple CMake project configured with **cifuzz** and hasone 
+Fuzz Test.
 
-You can start the fuzzing with
+## Run
 
 ```bash
 cifuzz run my_fuzz_test
 ```
 
+The Fuzz Test should trigger a Heap Buffer Overflow.
+
 ## Create regression test
 
 After you have discovered a finding, you may want to include this as
-part of a regression test. This can be done by building the fuzz test
-(my_fuzz_test) as a replayer binary. It is recommended to use the
+part of a regression test. This can be done by building the Fuzz Test
+(`my_fuzz_test`) as a replayer binary. It is recommended to use the
 provided CMake user presets, which can be generated with `cifuzz integrate cmake`.
 
 ```bash
@@ -24,4 +25,4 @@ cmake --build --preset="cifuzz (Regression Test)"
 
 To execute the replayer binary, run `./.cifuzz-build/replayer/address+undefined/my_fuzz_test`.
 When you run the replayer binary, it will use any findings located in
-the my_fuzz_test_inputs directory as input.
+the `my_fuzz_test_inputs` directory as input.

example-projects/simple-setup/gradle-junit-4-and-5/README.md

@@ -1,12 +1,13 @@
-# cifuzz Gradle example
+## Project Description
 
-This is a simple Gradle based project with both JUnit 4 and JUnit 5 unit tests 
-and a fuzz test.
-It should quickly produce a finding, but slow enough to
-see the progress of the fuzzer.
+This is a simple Gradle Java project configured with **cifuzz** and includes
+one Fuzz Test and one JUnit 4 as well as one JUnit 5 Unit Test, demonstrating 
+the use of the `junit-vintage-engine`.
 
-You can start fuzzing with
+## Run
 
 ```bash
 cifuzz run com.example.ExploreFuzzTest::myFuzzTest 
 ```
+The Fuzz Test should trigger a Remote Code Execution.
+

example-projects/simple-setup/gradle-kotlin/README.md

@@ -1,22 +1,17 @@
-# cifuzz Gradle example
+## Project Description
 
-This is a simple Gradle based Kotlin project, already configured with
-**cifuzz**. It should quickly produce a finding, but slow enough to
-see the progress of the fuzzer.
+This is a simple Gradle Kotlin project configured with **cifuzz** and includes
+one Fuzz Test.
 
-You can start fuzzing with
+## Run
 
 ```bash
 cifuzz run com.example.FuzzTestCase::myFuzzTest
 ```
 
-## Coverage
-
-cifuzz can generate Java coverage reports using
-[jacoco](https://www.jacoco.org). This example is configured to use both HTML
-and XML (e.g. for IDE support) as output formats.
+The Fuzz Test should trigger a Remote Code Execution.
 
-Run the coverage command after your cifuzz run:
+## Coverage
 
 ```bash
 cifuzz coverage com.example.FuzzTestCase::myFuzzTest

example-projects/simple-setup/gradle/README.md

@@ -1,22 +1,17 @@
-# cifuzz Gradle example
+## Project Description
 
-This is a simple Gradle based Java project, already configured with
-**cifuzz**. It should quickly produce a finding, but slow enough to
-see the progress of the fuzzer.
+This is a simple Gradle Java project configured with **cifuzz** and has
+one Fuzz Test.
 
-You can start fuzzing with
+## Run
 
 ```bash
 cifuzz run com.example.FuzzTestCase::myFuzzTest
 ```
 
-## Coverage
-
-cifuzz can generate Java coverage reports using
-[jacoco](https://www.jacoco.org). This example is configured to use both HTML
-and XML (e.g. for IDE support) as output formats.
+The Fuzz Test should trigger a Remote Code Execution.
 
-Run the coverage command after your cifuzz run:
+## Coverage
 
 ```bash
 cifuzz coverage com.example.FuzzTestCase::myFuzzTest