Refocus main README on user experience and getting started#64
Draft
Refocus main README on user experience and getting started#64
Conversation
Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README to enhance user experience and usage modes
Refocus main README on user experience and getting started
Mar 2, 2026
mawad-amd
reviewed
Mar 2, 2026
README.md
Outdated
| Traditional CPU and GPU profiling and analysis tools expose raw hardware counters and assembly. IntelliKit tools are designed to: | ||
| ```bash | ||
| curl -sSL https://raw.githubusercontent.com/AMDResearch/intellikit/main/install/tools/install.sh | bash | ||
| ``` |
Member
There was a problem hiding this comment.
@copilot you need to add the skills too. Also, options are great but we can refer to a asperate readme with all options...
Contributor
Author
There was a problem hiding this comment.
Done in a0714f1:
- Skills install command is now in the Installation section alongside the tools install command
- Created
install/README.mdwith full options for both the tools and skills install scripts (tables, examples, env vars) - Replaced the inline options list in the main README with a single line linking to
install/README.md - Removed the separate "Agent Skills" section since it's now covered in Installation + the dedicated README
… section of main README Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The main README mixed user-facing getting-started content with design philosophy and verbose internal explanations, making it harder to quickly onboard.
Changes
install/README.md— dedicated reference for all install options (custom pip command, branch/tag, agent targets, dry-run, env vars) for both the tools and skills install scriptsinstall/README.mdinstall/README.mdPer-tool quick examples, documentation links, contributing, and license sections unchanged.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.