⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Conversation

@harp-intel
Copy link
Contributor

This pull request updates the README.md to improve the clarity and usability of PerfSpect's documentation, focusing on better formatting, clearer examples, and enhanced explanations for various commands. Additionally, it updates the project version in version.txt from 3.13.0-dev to the official release 3.13.0.

Documentation improvements:

  • Reformatted all command-line examples in README.md to use fenced code blocks (```text) instead of <pre> tags, improving readability and consistency. [1] [2] [3] [4]
  • Added clarifying notes, usage tips, and improved descriptions for various commands (such as metrics, report, benchmark, flamegraph, lock, and config) to help users better understand PerfSpect's features and options. [1] [2] [3]
  • Updated the "memory" benchmark description to clarify where to download the Intel Memory Latency Checker and how to install it.

Version update:

  • Updated version.txt from 3.13.0-dev to 3.13.0 to reflect the new release version.

Signed-off-by: Harper, Jason M <[email protected]>
@harp-intel harp-intel requested a review from Copilot January 17, 2026 23:53
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR prepares PerfSpect for the 3.13.0 release by updating the version identifier and improving documentation formatting and clarity throughout the README.

Changes:

  • Updated version from 3.13.0-dev to 3.13.0 in version.txt
  • Converted all command examples in README from <pre> tags to fenced code blocks for better readability
  • Enhanced documentation with additional usage tips, clarifying notes, and improved command descriptions

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
version.txt Updated version from development to release version
README.md Reformatted code examples and added clarifying documentation throughout

@harp-intel harp-intel merged commit a23b2d4 into main Jan 18, 2026
5 checks passed
@harp-intel harp-intel deleted the prep313 branch January 18, 2026 23:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants