Skip to content

docs(readme): make hls4ml logo clickable and update badge URLs#1487

Open
niteshg97 wants to merge 3 commits into
fastmachinelearning:mainfrom
niteshg97:main
Open

docs(readme): make hls4ml logo clickable and update badge URLs#1487
niteshg97 wants to merge 3 commits into
fastmachinelearning:mainfrom
niteshg97:main

Conversation

@niteshg97
Copy link
Copy Markdown
Contributor

@niteshg97 niteshg97 commented Jun 5, 2026

Description

This PR updates the README to improve the rendering and usability of project assets.

Changes include:

  • Making the hls4ml logo clickable and linking it to the fastmachinelearning.github.io repository.
  • Updating the logo image source to a reliably rendered image.
  • Fixing broken or outdated badge/image links in the README.
  • Improving badge and image rendering consistency on GitHub.

Dependencies:

  • No additional dependencies are required.

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • Documentation update
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • A new research paper code implementation
  • Other (Specify)

Tests

Verified the changes by:

  1. Previewing the README on GitHub.
  2. Confirming that the hls4ml logo renders correctly.
  3. Confirming that clicking the logo redirects to the intended repository.
  4. Verifying that the updated badges and links resolve correctly.

Test Configuration:

  • GitHub README renderer
  • Web browser

Checklist

  • I have read the guidelines for contributing.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have installed and run pre-commit on the files I edited or added.
  • I have added tests that prove my fix is effective or that my feature works.

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.

1 participant