Update readme #6625
Update readme #6625
Conversation
kristenwomack
requested review from
JeffreyCA,
hemarina,
rajeshkamal5050,
tg-msft,
vhvb1989,
wbreza and
weikanglim
as code owners
There was a problem hiding this comment.
Pull request overview
This PR updates the README to improve clarity, organization, and add guidance for AI agents. The changes transform the README from a functional but dense document into a more modern, user-friendly guide with better visual hierarchy and clearer sections.
Changes:
- Restructured content with improved visual hierarchy using badges, sections, and collapsible details
- Enhanced installation instructions with all methods grouped by platform and clearer guidance
- Added "AI Agents" section linking to AGENTS.md for contributors and providing guidance for users of AI coding assistants
- Updated terminology for consistency (e.g., "Mac" → "macOS")
- Simplified and clarified data collection, contributing, and legal sections
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Azure Developer CLI (`azd`) | ||
|
|
||
| Latest builds: | ||
| > **From code to cloud in minutes.** A developer-centric CLI for building, deploying, and managing Azure applications with Infrastructure as Code (IaC). |
There was a problem hiding this comment.
Instead of managing Azure applications with Infrastructure as Code (IaC), should we consider aligning to "build->deploy->operate?"
| ```powershell | ||
| winget install microsoft.azd | ||
| ``` | ||
| **Contributing to this repo?** See [AGENTS.md](AGENTS.md) for coding standards and guidelines. |
There was a problem hiding this comment.
link to agents.md is a 404.
There was a problem hiding this comment.
@copilot please fix, it should be cli/azd/AGENTS.md
|
@kristenwomack I've opened a new pull request, #6638, to work on those changes. Once the pull request is ready, I'll request review from you. |
|
@kristenwomack I've opened a new pull request, #6639, to work on those changes. Once the pull request is ready, I'll request review from you. |
closes #6624