Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit, reformat, and embellish README.md #905

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

mhucka
Copy link
Contributor

@mhucka mhucka commented Mar 17, 2025

Changes (these can be viewed as proposed changes, not needs or demands):

  • Add standard Google disclaimer
  • Add QAI contact info
  • Add QAI logo at the bottom, for extra flair
  • Add a logo variant with the Stim name and use that as the heading
  • Center the top parts, which (IMHO) looks a little nicer
  • Reformat file to follow Google Markdown style, with the exception of the line length, which is set to 120 characters to match the value in .clang-format.
  • Make a few tiny edits, such as capitalizing Stim and Python consistently, using consistent markup for emphasis of text, etc.

mhucka added 3 commits March 17, 2025 15:46
Changes (these can be viewed as proposed changes, not needs or demands):

* Add standard Google disclaimer
* Add QAI contact info
* Add QAI logo at the bottom, for extra flair
* Add a logo variant with the Stim name and use that as the heading
* Center the top parts, which (IMHO) looks a little nicer
* Reformat file to follow Google Markdown style, with the exception of
  the line length, which is set to 120 characters to match the value
  in `.clang-format`.
@mhucka mhucka marked this pull request as ready for review March 18, 2025 01:07
@mhucka mhucka requested a review from Strilanc March 18, 2025 01:07
mhucka added 2 commits March 24, 2025 19:30
I was advised by the product marketing team that we should wait for an
official Stim lockup, so I'm taking out the one I created and
readjusted the top of the page.
@mhucka
Copy link
Contributor Author

mhucka commented Mar 25, 2025

@Strilanc I was advised by our marketing/design team that we should wait for an official version of the lockup rather than use a temporary one I created. So, I rejigged the top of the file again to make do without. Sorry to waste your time with another review, but I don't feel comfortable merging it until your say-so.

@mhucka
Copy link
Contributor Author

mhucka commented Mar 25, 2025

FWIW here are screenshots of what it looks like.

mhucka added 2 commits March 25, 2025 20:16
Relatively URLs for logos & images don't work on PyPI, but absolute
ones do.
@mhucka mhucka requested a review from Strilanc March 26, 2025 14:53
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.

None yet

2 participants