fix: corrected READMEs and info on doc generation

Author: jasonjdominguez99

.gitignore

@@ -57,6 +57,9 @@ compile_commands.json
 coverage/
 coverage.info
 
+# Documentation
+docs/
+
 # IDE
 .vscode/*
 !.vscode/settings.json

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,189 @@
+# Contributing
+
+Thank you for your interest in contributing! This guide will help you get started.
+
+## Development Setup
+
+### Prerequisites
+
+- CMake 3.25+
+- C++23 compatible compiler (GCC 14+ or Clang 16+)
+- Python 3.7+ (for pre-commit hooks)
+- (Optional) lcov for coverage reports
+
+### Initial Setup
+
+```bash
+# Clone the repository
+git clone <your-repo-url>
+cd modern-cpp-project-template
+
+# Install pre-commit hooks
+pip install pre-commit
+pre-commit install
+```
+
+## Building the Project
+
+### Using Convenience Scripts
+
+```bash
+# Build in release mode (default)
+./scripts/build.sh
+
+# Build in debug mode
+./scripts/build.sh debug
+
+# Build with Thread Sanitizer
+./scripts/build.sh tsan
+```
+
+### Manual CMake
+
+```bash
+cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
+cmake --build build
+```
+
+## Running Tests
+
+```bash
+# Run all tests
+./scripts/test.sh
+
+# Or manually
+cd build && ctest --output-on-failure
+```
+
+## Running Benchmarks
+
+```bash
+# Quick benchmarks
+./scripts/benchmark.sh
+
+# Full benchmarks
+./build/benchmarks/hello_world_benchmark
+```
+
+## Code Coverage
+
+```bash
+# Generate coverage report
+./scripts/coverage.sh
+
+# View results
+open coverage/html/index.html  # macOS
+xdg-open coverage/html/index.html  # Linux
+```
+
+## Code Style
+
+### Formatting (clang-format)
+
+This project uses **Google C++ Style** with clang-format.
+
+```bash
+# Format all files
+pre-commit run clang-format --all-files
+
+# Or manually
+clang-format -i src/*.cpp include/*.h
+```
+
+Pre-commit hooks will automatically format code before commits.
+
+## Documentation Style
+
+Use Doxygen comments for all public APIs:
+
+```cpp
+/**
+ * @brief Brief description of the function
+ *
+ * Detailed description if needed.
+ *
+ * @param name Parameter description
+ * @return Description of return value
+ */
+std::string my_function(const std::string& name);
+```
+
+See `include/hello_world.h` for examples.
+
+### Generating Documentation
+
+```bash
+# Install Doxygen (if not already installed)
+brew install doxygen  # macOS
+# or
+sudo apt install doxygen  # Linux
+
+# Generate documentation
+./scripts/docs.sh
+
+# Or manually
+doxygen Doxyfile
+
+# View generated docs
+open docs/html/index.html  # macOS
+xdg-open docs/html/index.html  # Linux
+```
+
+The generated documentation will be in the `docs/` directory (git-ignored).
+
+## Pull Request Process
+
+1. **Create a branch** from `master` for your changes
+2. **Make your changes** following the code style
+3. **Add tests** for new functionality
+4. **Run tests and coverage** to ensure nothing breaks
+5. **Update documentation** if adding features
+6. **Run pre-commit hooks**: `pre-commit run --all-files`
+7. **Submit a PR** with a clear description of changes
+
+### PR Checklist
+
+- [ ] Code follows style guide (clang-format applied)
+- [ ] All tests pass (`./scripts/test.sh`)
+- [ ] New tests added for new features
+- [ ] Documentation updated (if needed)
+- [ ] Pre-commit hooks pass
+- [ ] No compiler warnings
+
+## Commit Messages
+
+Write clear, concise commit messages:
+
+```
+Brief summary (50 chars or less)
+
+More detailed explanation if needed. Wrap at 72 characters.
+Explain the problem this commit solves and why this approach
+was chosen.
+```
+
+## Project Structure
+
+```
+.
+├── src/                 # Source files (.cpp)
+├── include/             # Public headers (.h)
+├── tests/               # Unit tests (Google Test)
+├── benchmarks/          # Performance benchmarks (Google Benchmark)
+├── scripts/             # Build/test convenience scripts
+├── .github/workflows/   # CI/CD configuration
+├── CMakeLists.txt       # Main CMake configuration
+├── Doxyfile             # Doxygen configuration for API docs
+├── .clang-format        # Code formatting rules
+└── .pre-commit-config.yaml  # Pre-commit hooks
+```
+
+## Getting Help
+
+- Open an issue for bugs or feature requests
+- Check existing issues before creating new ones
+- Be respectful and constructive in discussions
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the same license as the project.