Skip to content

docs: readme formatting#4938

Merged
engelke merged 5 commits into
masterfrom
grant_readme_touchup
Nov 5, 2020
Merged

docs: readme formatting#4938
engelke merged 5 commits into
masterfrom
grant_readme_touchup

Conversation

@grant

@grant grant commented Nov 4, 2020

Copy link
Copy Markdown
Contributor

Description

Fixes #4837

  • Formats the README
    • (Similar to the markdown in the Node repo)
  • Includes generic how to run instructions

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>
@grant grant requested a review from engelke November 4, 2020 17:43
@grant grant requested a review from a team as a code owner November 4, 2020 17:43
@grant grant self-assigned this Nov 4, 2020
@google-cla google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 4, 2020

@engelke engelke left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. Thanks for this!

Comment thread README.md Outdated
Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>
@grant grant force-pushed the grant_readme_touchup branch from 24977f0 to 6400a11 Compare November 4, 2020 19:05

@leahecole leahecole left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM - just want to double check with the other @GoogleCloudPlatform/python-samples-owners - this isn't a generated file, right? (I'm mostly certain it's not generated in this repo) and as long as it's not, I'm cool with it. Thank you for doing this, @grant !

Comment thread README.md Outdated
Comment thread README.md
@busunkim96

Copy link
Copy Markdown
Contributor

LGTM - just want to double check with the other @GoogleCloudPlatform/python-samples-owners - this isn't a generated file, right? (I'm mostly certain it's not generated in this repo) and as long as it's not, I'm cool with it. Thank you for doing this, @grant !

I can confirm this one isn't generated.

grant and others added 2 commits November 5, 2020 11:07
Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com>
Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com>
Comment thread README.md
@grant

grant commented Nov 5, 2020

Copy link
Copy Markdown
Contributor Author

Please merge when approved, or request changes. :)

@engelke engelke merged commit b3448c8 into master Nov 5, 2020
@engelke engelke deleted the grant_readme_touchup branch November 5, 2020 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

A Better README

4 participants