README.md

PrettyScreenSHOT Documentation

This directory contains detailed documentation for the PrettyScreenSHOT project.

Documentation Index

Project Planning & Status

• ROADMAP.md - Development roadmap with planned features and phases
• STATUS_REPORT.md - Current project status, compliance, and metrics
• VERSIONING.md - Versioning system explanation and guidelines

Development Documentation

• ARCHITECTURE.md - Project architecture and design patterns
• LOGGING.md - Logging system documentation

Root Documentation

The following documentation files are located in the project root for easy access:

• ../README.md - Main project overview and quick start guide
• ../CHANGELOG.md - Version history and release notes
• ../CONTRIBUTING.md - Contribution guidelines
• ../LICENSE - Project license (GPL-3.0)

Test Documentation

• ../Tests/README.md - Unit testing guide and best practices

Additional Resources

Issue Templates

• Bug reports: .github/ISSUE_TEMPLATE/bug_report.md
• Feature requests: .github/ISSUE_TEMPLATE/feature_request.md

Build & Installation

• Installer files: build/installer/
  • InnoSetup script: Installer.iss
  • WiX script: Installer.wxs
  • Build script: build-installer.ps1