Improve README with comprehensive enhancements

[Copilot]

Thanks for the feedback on #1. I've created this new PR, which merges into #1, to address your comment. I have completed the improvements to the README as requested.

Original PR: #1
Triggering comment (#1 (comment)):

@copilot Improve README

Changes Made

This PR significantly improves the README.md file with comprehensive enhancements across multiple areas:

Enhanced API Examples

• Added comprehensive docstrings and inline comments explaining each step
• Improved code structure with clear step-by-step workflow (Step 1, Step 2, etc.)
• Added context about what each example demonstrates
• Included Gluon API comparison with key differences highlighted

Improved Quick Start Guide

• Reorganized into three clear options: Quick Installation, Docker Compose, and Local Development
• Added time estimates for Docker builds (45-60 minutes)
• Clarified which option is recommended for different use cases
• Added "Running Your First Example" section with verification commands

New Troubleshooting Section

• Common installation issues and solutions
• Docker-specific troubleshooting (build failures, timeouts)
• GPU and ROCm configuration issues
• Import and dependency problems with links to GitHub Issues

Better Documentation Organization

• Categorized documentation links into Getting Started, Conceptual Guides, and API References
• Added descriptive text for each documentation section
• Made the documentation structure more discoverable and navigable

Enhanced Prerequisites

• Detailed version requirements for all dependencies
• Added helpful tip about contributing without GPU access
• Clearer formatting for better readability

Improved Next Steps

• Expanded examples overview with specific topics (P2P, GEMM, FlashDecode, collectives)
• Added direct links to key learning resources
• Better structured guidance for new users getting started with Iris

Summary

• Files Changed: 1 (README.md)
• Lines Added: 142
• Lines Removed: 47
• Net Change: +95 lines

The README is now significantly more comprehensive and user-friendly, making it easier for new users to get started with Iris while also providing helpful resources for contributors.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[JoseSantosAMD]

@copilot Try again

[Copilot]

@copilot Try again

I've improved the README with comprehensive enhancements including:

• Better API Examples: Added detailed comments and step-by-step explanations for both standard and Gluon APIs
• Clearer Quick Start: Reorganized into 3 options with time estimates and use-case guidance
• Troubleshooting Section: Added common issues and solutions for installation, Docker, GPU setup, and dependencies
• Enhanced Documentation Structure: Categorized docs into Getting Started, Conceptual Guides, and API References
• Improved Prerequisites: More detailed requirements with helpful tips for contributors

The README is now more comprehensive and easier to follow for new users.

Commit: 401b590