Skip to content

Polish README #26320

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Polish README #26320

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edbcc28
Polish README.adoc
agg505 Apr 30, 2021
27e2173
Polish README.adoc
agg505 May 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,25 @@ Here is a quick teaser of a complete Spring Boot application in Java:
@SpringBootApplication
public class Example {

@RequestMapping("/")
String home() {
return "Hello World!";
}
@RequestMapping("/")
String home() {
return "Hello World!";
}

public static void main(String[] args) {
SpringApplication.run(Example.class, args);
}
public static void main(String[] args) {
SpringApplication.run(Example.class, args);
}

Copy link
Member

@wilkinsona wilkinsona Apr 30, 2021

Choose a reason for hiding this comment

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

We prefer tabs as they're more accessible.

Copy link
Contributor Author

@agg505 agg505 May 1, 2021

Choose a reason for hiding this comment

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

Ok, I see.

}
----



== Getting help
== Getting Help
Are you having trouble with Spring Boot? We want to help!

* Check the {docs}/html/[reference documentation], especially the {docs}/html/howto.html#howto[How-to's] -- they provide solutions to the most common questions.
* Learn the Spring basics -- Spring Boot builds on many other Spring projects; check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
Copy link
Member

@wilkinsona wilkinsona Apr 30, 2021

Choose a reason for hiding this comment

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

I think this should be -- so that they're rendered as an em dash.

Copy link
Contributor Author

@agg505 agg505 May 1, 2021

Choose a reason for hiding this comment

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

So to be consistent, change the single ‘-‘ to double for line 56?

Copy link
Member

@wilkinsona wilkinsona May 1, 2021

Choose a reason for hiding this comment

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

Yes please.

* Check the {docs}/html/[reference documentation], especially the {docs}/html/howto.html#howto[How-to's] - they provide solutions to the most common questions.
* Learn the Spring basics - Spring Boot builds on many other Spring projects; check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
If you are new to Spring, try one of the https://spring.io/guides[guides].
* If you are upgrading, read the {github}/wiki[release notes] for upgrade instructions and "new and noteworthy" features.
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-boot[`spring-boot`].
Expand Down