Updated documentation and shell scripts

Author: vpiotr

.gitignore

@@ -50,4 +50,9 @@ install_manifest.txt
 # Package files
 *.deb
 *.rpm
-*.dmg
+*.dmg
+
+# Miscellaneous
+*.log
+*.tmp
+todo.md

README.md

@@ -58,6 +58,33 @@ cmake --build .
 sudo cmake --install .
 ```
 
+## Helper Scripts
+
+The project includes several helper scripts for common tasks:
+
+- **`rebuild.sh`** - Clean and rebuild the entire project from scratch
+- **`run_demos.sh`** - Execute all demo programs sequentially with detailed output and summary
+- **`run_tests.sh`** - Run all test executables with summary reporting (use `--detailed` for full output)
+- **`build_docs.sh`** - Generate Doxygen documentation in HTML format
+
+Usage examples:
+```bash
+# Quick rebuild
+./rebuild.sh
+
+# Run all demos with colored output
+./run_demos.sh
+
+# Run tests with summary only
+./run_tests.sh
+
+# Run tests with detailed output
+./run_tests.sh --detailed
+
+# Generate documentation
+./build_docs.sh
+```
+
 ## CMake Options
 
 - `UTEST_BUILD_DEMO`: Build the demo project (ON by default)
@@ -139,24 +166,68 @@ See tests in "tests" subdirectory and the "demo" directory for more examples.
 
 ## Demo Project
 
-The demo project demonstrates various aspects of the library:
-- Basic assertions (equality, true/false)
-- Assertions with custom error messages
-- Testing exceptions
-- Complex test scenarios with collections
+The demo project demonstrates various aspects of the library across multiple executable demos:
+
+### Available Demos
+
+#### 1. Core Features Demo (`utest_demo`)
+- **File**: `demo_core_features.cpp`
+- **Executable**: `./bin/utest_demo`
+- **Features demonstrated**:
+  - Basic assertions (equality, true/false)
+  - Assertions with custom error messages
+  - Exception testing with lambda functions
+  - Complex test scenarios with collections and vectors
+  - String comparisons and container operations
+
+#### 2. Unicode Checkmarks Demo (`demo_unicode_checkmarks`)
+- **File**: `demo_unicode_checkmarks.cpp`
+- **Executable**: `./bin/demo_unicode_checkmarks`
+- **Features demonstrated**:
+  - Default Unicode checkmark output format
+  - Test grouping with `UTEST_FUNC_DEF2` syntax
+  - Multiple grouped test scenarios
+  - Various assertion types (GT, GTE, NEQ, etc.)
+
+#### 3. Verbose Mode Demo (`demo_verbose_mode`)
+- **File**: `demo_verbose_mode.cpp` 
+- **Executable**: `./bin/demo_verbose_mode`
+- **Features demonstrated**:
+  - Verbose output mode showing test names before execution
+  - Performance timing measurements
+  - Grouped test organization and display
+  - Test progress tracking
+
+#### 4. Failure Handling Demo (`demo_with_failure`)
+- **File**: `demo_with_failure.cpp`
+- **Executable**: `./bin/demo_with_failure`
+- **Features demonstrated**:
+  - Intentional test failures for error reporting demonstration
+  - Comprehensive error messages with file/line information
+  - Mixed passing and failing tests in the same runner
+  - Error handling and exit code behavior
+
+#### 5. No Tests Scenario Demo (`demo_no_tests`) 
+- **File**: `demo_no_tests.cpp`
+- **Executable**: `./bin/demo_no_tests`
+- **Features demonstrated**:
+  - Behavior when no tests are registered or executed
+  - Default failure handling for empty test suites
+  - Use of `UTEST_ALLOW_EMPTY_TESTS()` for conditional testing
 
 To run all demos:
 ```bash
 mkdir _build && cd _build
 cmake ..
 cmake --build .
-./run_all_demos.sh
+./run_demos.sh
 ```
 
 To run individual demos:
 ```bash
 ./bin/utest_demo                # Core features demo
-./bin/demo_unicode_checkmarks   # Unicode checkmarks demo
+./bin/demo_unicode_checkmarks   # Unicode checkmarks demo  
+./bin/demo_verbose_mode         # Verbose mode demo
 ./bin/demo_with_failure         # Failure handling demo
 ./bin/demo_no_tests             # No tests scenario demo
 ```
@@ -208,7 +279,7 @@ make: *** [Makefile:84: test] Error 8
 
 ### Configuration Macros
 - `UTEST_ALLOW_EMPTY_TESTS()` - Allow test runner to succeed even when no tests are run
-- `UTEST_USE_ASCII_CHECKMARKS()` - Use ASCII [OK]/[FAIL] instead of Unicode ✓/✗
+- `UTEST_USE_ASCII_CHECKMARKS()` - Use ASCII [OK]/[FAIL] instead of Unicode checkmarks
 - `UTEST_SHOW_PERFORMANCE()` - Enable performance timing for each test
 - `UTEST_ENABLE_VERBOSE_MODE()` - Show test names before execution (useful for debugging)
 
@@ -246,9 +317,9 @@ make: *** [Makefile:84: test] Error 8
 
 ## Build Organization
 
-The build system now organizes binaries into dedicated subdirectories:
+The build system organizes binaries into dedicated subdirectories:
 - Main demo: `bin/utest_demo`
-- Additional demos: `bin/demo_with_failure`, `bin/demo_no_tests`
+- Additional demos: `bin/demo_unicode_checkmarks`, `bin/demo_verbose_mode`, `bin/demo_with_failure`, `bin/demo_no_tests`
 - Tests: `bin/tests/test_*`
 
 ## Handling No Tests Scenario
@@ -290,8 +361,8 @@ UTEST_FUNC2(ModuleA, Feature2);
 In the test summary, tests with the same group name will be displayed together:
 ```
 ModuleA:
-✓ Feature1
-✓ Feature2
+[OK] Feature1
+[OK] Feature2
 ```
 
 ### Performance Timing
@@ -306,7 +377,7 @@ UTEST_EPILOG();
 
 Output will show timing information:
 ```
-✓ Test [my_test] succeeded (1.234ms)
+[OK] Test [my_test] succeeded (1.234ms)
 ```
 
 ### Verbose Mode
@@ -322,21 +393,21 @@ UTEST_EPILOG();
 Output will show test names before execution:
 ```
 Running test: my_test
-✓ Test [my_test] succeeded (1.234ms)
+[OK] Test [my_test] succeeded (1.234ms)
 ```
 
 For grouped tests:
 ```
 Running test: GroupName::TestName
-✓ Test [GroupName::TestName] succeeded (1.234ms)
+[OK] Test [GroupName::TestName] succeeded (1.234ms)
 ```
 
 ### ASCII Checkmarks
 For environments that don't support Unicode characters:
 
 ```cpp
 UTEST_PROLOG();
-UTEST_USE_ASCII_CHECKMARKS(); // Use [OK]/[FAIL] instead of ✓/✗
+UTEST_USE_ASCII_CHECKMARKS(); // Use [OK]/[FAIL] instead of Unicode checkmarks
 UTEST_FUNC(my_test);
 UTEST_EPILOG();
 ```

build_docs.sh

@@ -49,7 +49,7 @@ doxygen Doxyfile
 
 if [ $? -eq 0 ]; then
     echo
-    echo -e "${GREEN}✓ Documentation generated successfully!${NC}"
+    echo -e "${GREEN}[OK] Documentation generated successfully!${NC}"
     echo
     echo -e "${BLUE}Documentation location:${NC}"
     echo "  HTML: $(pwd)/docs/html/index.html"
@@ -68,7 +68,7 @@ if [ $? -eq 0 ]; then
         fi
     fi
 else
-    echo -e "${RED}✗ Documentation generation failed!${NC}"
+    echo -e "${RED}[FAIL] Documentation generation failed!${NC}"
     echo "Check the Doxygen output above for error details."
     exit 1
 fi

rebuild.sh

@@ -1,3 +1,18 @@
-rm -rf build && mkdir build && cd build && cmake .. && cmake --build .
+#!/bin/bash
+
+echo "========================================"
+echo "Rebuilding utest library project"
+echo "========================================"
+
+echo "Cleaning previous build..."
+rm -rf build && mkdir build && cd build
+
+echo "Configuring with CMake..."
+cmake ..
+
+echo "Building project..."
+cmake --build .
+
+echo "Build completed successfully!"
 
 

run_all_demos.sh run_demos.shrun_all_demos.sh renamed to run_demos.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# run_all_demos.sh - Script to run all demo programs for utest library
+# run_demos.sh - Script to run all demo programs for utest library
 
 # Colors for output
 RED='\033[0;31m'
@@ -43,28 +43,28 @@ run_demo() {
         if [ "$demo_name" = "demo_with_failure" ]; then
             # This demo is expected to fail
             if [ $exit_code -ne 0 ]; then
-                echo -e "${YELLOW}⚠ Demo completed with expected failure (exit code: $exit_code)${NC}"
+                echo -e "${YELLOW}[WARNING] Demo completed with expected failure (exit code: $exit_code)${NC}"
                 return 0
             else
-                echo -e "${RED}✗ Demo was expected to fail but succeeded (exit code: $exit_code)${NC}"
+                echo -e "${RED}[FAIL] Demo was expected to fail but succeeded (exit code: $exit_code)${NC}"
                 return 1
             fi
         elif [ "$demo_name" = "demo_no_tests" ]; then
             # This demo might succeed or fail depending on configuration
-            echo -e "${GREEN}✓ Demo completed (exit code: $exit_code)${NC}"
+            echo -e "${GREEN}[OK] Demo completed (exit code: $exit_code)${NC}"
             return 0
         else
             # Normal demos should succeed
             if [ $exit_code -eq 0 ]; then
-                echo -e "${GREEN}✓ Demo completed successfully${NC}"
+                echo -e "${GREEN}[OK] Demo completed successfully${NC}"
                 return 0
             else
-                echo -e "${RED}✗ Demo failed unexpectedly (exit code: $exit_code)${NC}"
+                echo -e "${RED}[FAIL] Demo failed unexpectedly (exit code: $exit_code)${NC}"
                 return 1
             fi
         fi
     else
-        echo -e "${RED}✗ Demo executable not found: $demo_path${NC}"
+        echo -e "${RED}[FAIL] Demo executable not found: $demo_path${NC}"
         return 1
     fi
 
@@ -81,22 +81,27 @@ echo -e "${YELLOW}Running all utest framework demos...${NC}"
 echo
 
 # Main demo - core functionality
-echo -e "${BLUE}>>> Demo 1/4: Core Features${NC}"
+echo -e "${BLUE}>>> Demo 1/5: Core Features${NC}"
 ((TOTAL_DEMOS++))
 run_demo "utest_demo" "Core Features Demo" || ((FAILED_DEMOS++))
 
 # Unicode checkmarks demo
-echo -e "${BLUE}>>> Demo 2/4: Unicode Checkmarks${NC}"
+echo -e "${BLUE}>>> Demo 2/5: Unicode Checkmarks${NC}"
 ((TOTAL_DEMOS++))
 run_demo "demo_unicode_checkmarks" "Unicode Checkmarks Demo" || ((FAILED_DEMOS++))
 
+# Verbose mode demo
+echo -e "${BLUE}>>> Demo 3/5: Verbose Mode${NC}"
+((TOTAL_DEMOS++))
+run_demo "demo_verbose_mode" "Verbose Mode Demo" || ((FAILED_DEMOS++))
+
 # Failure handling demo
-echo -e "${BLUE}>>> Demo 3/4: Failure Handling${NC}"
+echo -e "${BLUE}>>> Demo 4/5: Failure Handling${NC}"
 ((TOTAL_DEMOS++))
 run_demo "demo_with_failure" "Failure Handling Demo" || ((FAILED_DEMOS++))
 
 # No tests scenario demo
-echo -e "${BLUE}>>> Demo 4/4: No Tests Scenario${NC}"
+echo -e "${BLUE}>>> Demo 5/5: No Tests Scenario${NC}"
 ((TOTAL_DEMOS++))
 run_demo "demo_no_tests" "No Tests Scenario Demo" || ((FAILED_DEMOS++))
 
@@ -106,7 +111,7 @@ echo -e "${BLUE}                Demo Summary${NC}"
 echo -e "${BLUE}===============================================${NC}"
 
 if [ $FAILED_DEMOS -eq 0 ]; then
-    echo -e "${GREEN}✓ All $TOTAL_DEMOS demos completed successfully!${NC}"
+    echo -e "${GREEN}[OK] All $TOTAL_DEMOS demos completed successfully!${NC}"
     echo
     echo -e "${CYAN}The utest framework is working correctly and ready for use.${NC}"
     echo
@@ -117,12 +122,13 @@ if [ $FAILED_DEMOS -eq 0 ]; then
     echo "  • Performance timing with microsecond precision"
     echo "  • Test grouping and organization"
     echo "  • Configurable output formats (ASCII/Unicode)"
-    echo "  • Comprehensive error reporting"
-    echo "  • Robust failure handling"
+    echo "  • Verbose mode for detailed test execution tracking"
+    echo "  • Comprehensive error reporting and failure handling"
+    echo "  • Empty test suite scenarios and configuration"
     echo
-    echo -e "${GREEN}All demos completed successfully! 🎉${NC}"
+    echo -e "${GREEN}All demos completed successfully!${NC}"
 else
-    echo -e "${RED}✗ $FAILED_DEMOS out of $TOTAL_DEMOS demos failed${NC}"
+    echo -e "${RED}[FAIL] $FAILED_DEMOS out of $TOTAL_DEMOS demos failed${NC}"
     echo
     echo -e "${YELLOW}Please check the output above for details.${NC}"
     exit 1

run_all_tests.sh run_tests.shrun_all_tests.sh renamed to run_tests.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Test runner script for utest library
+# run_tests.sh - Test runner script for utest library
 # Runs all pre-built test binaries from the build directory
 
 echo "========================================"
@@ -34,11 +34,11 @@ run_test() {
         # Run the test and capture exit code
         if "$test_exec" > /dev/null 2>&1; then
             local exit_code=$?
-            echo "✓ Test execution successful (exit code: $exit_code)"
+            echo "[OK] Test execution successful (exit code: $exit_code)"
             ((PASS_COUNT++))
         else
             local exit_code=$?
-            echo "✗ Test execution failed (exit code: $exit_code)"
+            echo "[FAIL] Test execution failed (exit code: $exit_code)"
             # For tests designed to fail (like test_no_tests), this is expected
             if [[ "$test_name" == "test_no_tests" ]] || [[ "$test_name" == *"failure"* ]]; then
                 echo "  (This test is designed to fail - expected behavior)"
@@ -48,7 +48,7 @@ run_test() {
             fi
         fi
     else
-        echo "✗ Test executable not found: $test_exec"
+        echo "[FAIL] Test executable not found: $test_exec"
         ((FAILED_TESTS++))
     fi
 
@@ -69,7 +69,7 @@ run_test_detailed() {
         # Run the test with full output
         "$test_exec" || true
     else
-        echo "✗ Test executable not found: $test_exec"
+        echo "[FAIL] Test executable not found: $test_exec"
     fi
 }
 
@@ -104,10 +104,10 @@ else
     echo "Passed tests: $PASS_COUNT"
 
     if [ $FAILED_TESTS -eq 0 ]; then
-        echo "✓ All tests passed!"
+        echo "[OK] All tests passed!"
         exit 0
     else
-        echo "✗ Some tests failed!"
+        echo "[FAIL] Some tests failed!"
         echo ""
         echo "Run with --detailed flag to see full test output"
         exit 1