-
Notifications
You must be signed in to change notification settings - Fork 10.4k
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
Update README.md #4231
Conversation
There was a problem hiding this 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 | |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 | |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
now looks good |
There was a problem hiding this 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.
yes agree about the | char is may be not well. so my recent commit is ok? |
feature section in table format.