docs: update README

[sayalibhavsar]

Description

changes made to passmark-wrapper documentation

Before/After Comparison

Changes include a template followed across all wrapper

Solves issue: #71
Relates to JIRA: RPOPC-943

[github-actions]

This relates to RPOPC-943

[qodo-code-review]

Review Summary by Qodo

Comprehensive README documentation for STREAM wrapper

📝 Documentation

Walkthroughs

Description

• Completely rewrote README with comprehensive documentation
• Added detailed command-line options and parameter descriptions
• Documented complete workflow from environment setup to result verification
• Added STREAM benchmark theory, kernels, and output file descriptions
• Included multiple usage examples and troubleshooting guidance

Diagram

flowchart LR
  A["Old README<br/>Basic overview"] -->|"Expand & Restructure"| B["New README<br/>Comprehensive guide"]
  B --> C["Description &<br/>Features"]
  B --> D["Command-line<br/>Options"]
  B --> E["Workflow<br/>Details"]
  B --> F["STREAM Theory &<br/>Kernels"]
  B --> G["Usage Examples &<br/>Troubleshooting"]

Loading

File Changes

1. README.md 📝 Documentation +288/-53

Comprehensive documentation expansion and restructuring

• Replaced basic 58-line overview with comprehensive 293-line documentation
• Added detailed description of wrapper capabilities and features
• Documented all command-line options with defaults and descriptions
• Added 9-step workflow explanation covering environment setup through result verification
• Included STREAM benchmark theory with kernel operations and performance metrics
• Added 7 practical usage examples with command syntax and explanations
• Documented array sizing algorithm, thread/socket scaling, and cache detection
• Added architecture support details, memory considerations, and special cases
• Included troubleshooting section and performance optimization tips
• Added output files reference and return codes documentation

README.md

---

[qodo-code-review]

Code Review by Qodo

Looking for bugs?

Check back in a few minutes. An AI review agent is analyzing this pull request.

[dvalinrh]

LGTM