Skip to content

Update README.md #4231

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

Merged
merged 4 commits into from
May 15, 2023
Merged

Update README.md #4231

merged 4 commits into from
May 15, 2023

Conversation

yagneshprajapati
Copy link
Contributor

@yagneshprajapati yagneshprajapati commented May 7, 2023

feature section in table format.

Copy link
Member

@derekmauro derekmauro left a comment

Choose a reason for hiding this comment

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

Can you update the description of this change to describe what is changing? "Update README.md" is too general a description. Please describe how it is changing.

README.md Outdated
@@ -41,7 +41,7 @@ This repository is a merger of the formerly separate GoogleTest and GoogleMock
projects. These were so closely related that it makes sense to maintain and
release them together.

### Getting Started
### | Getting Started |
Copy link
Member

Choose a reason for hiding this comment

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

Why are there | chars around Getting Started?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it indicate that "Getting Started" is a heading in a larger body of text, also drawing attention to it.

Copy link
Member

Choose a reason for hiding this comment

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

Please take a look at the preview of the file: https://github.com/google/googletest/blob/a7fa9b37082993107a98181e631cafcdbe484f22/README.md#-getting-started-

I don't think the markdown is rendering as you intend.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ya i think that too, that why changed | char to simple one like "Getting Started"

README.md Outdated
* XML test report generation.
| Feature | Description |
| --- | --- |
| xUnit test framework | Googletest is based on the xUnit testing framework, a popular architecture for unit testing |
Copy link
Member

Choose a reason for hiding this comment

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

Can you restore the xUnit link?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes done!!

xunit link
xUnit link
xml report gan removed
@yagneshprajapati
Copy link
Contributor Author

now looks good

Copy link
Member

@derekmauro derekmauro left a comment

Choose a reason for hiding this comment

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

See my comment on the rendering.

@yagneshprajapati
Copy link
Contributor Author

See my comment on the rendering.

yes agree about the | char is may be not well. so my recent commit is ok?

@copybara-service copybara-service bot merged commit 60c3602 into google:main May 15, 2023
@pratyush3757 pratyush3757 mentioned this pull request Jun 1, 2023
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