Skip to content

docs: rich README + logo at docs/assets/#1

Merged
ammar-s847 merged 1 commit into
mainfrom
readme-and-logo
May 26, 2026
Merged

docs: rich README + logo at docs/assets/#1
ammar-s847 merged 1 commit into
mainfrom
readme-and-logo

Conversation

@ammar-s847
Copy link
Copy Markdown
Contributor

Summary

  • Rewrites the README in the format used by the umbrella hebb project — centered header, status badges, what-is / who-for tables, a features list, Rust + Python quick-starts.
  • Adds docs/assets/logo.png (same image as the desktop app icon for now) so the library repo doesn't reach into a desktop path.
  • Notes that the PyPI distribution is hebb-py while the Python module name is still hebb.

Test plan

  • Render preview of README on GitHub
  • Confirm logo + badges show correctly

Mirrors the format of the umbrella project README — centered header,
status badges, what-is/who-for tables, a features list, Rust + Python
quick-starts. Calls out that the PyPI distribution is `hebb-py` while
the Python module name is still `hebb`.

Logo lives at docs/assets/logo.png so the library repo isn't pulling
the desktop app icon path. Same image as the app for now.
@ammar-s847 ammar-s847 merged commit 11edb7b into main May 26, 2026
3 checks passed
@ammar-s847 ammar-s847 deleted the readme-and-logo branch May 26, 2026 16:20
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