Skip to content

Commit 7062d45

Browse files
authored
Some improvements
1 parent b0d4173 commit 7062d45

File tree

1 file changed

+6
-6
lines changed
  • content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository

1 file changed

+6
-6
lines changed

content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Repository README file
2+
title: Using a repository README file
33
shortTitle: About READMEs
44
intro: 'You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.'
55
redirect_from:
@@ -15,7 +15,7 @@ versions:
1515
topics:
1616
- Repositories
1717
---
18-
## About the repository README file
18+
## About READMEs
1919

2020
{% data reusables.repositories.about-READMEs %}
2121

@@ -36,25 +36,25 @@ When your README is viewed on GitHub, any content beyond 500 KiB will be truncat
3636

3737
{% data reusables.profile.profile-readme %}
3838

39-
## Auto-generated table of contents for README files
39+
## Auto-generated table of contents for markdown files
4040

4141
For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.github %} will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the {% octicon "list-unordered" aria-label="Table of Contents" %} menu icon at the top left of the rendered page.
4242

4343
![Screenshot of the README for a repository. In the upper-left corner, the "Table of contents" dropdown menu (list icon) is expanded.](/assets/images/help/repository/readme-automatic-toc.png)
4444

45-
## Section links in README files and blob pages
45+
## Section links in markdown files and blob pages
4646

4747
{% data reusables.repositories.section-links %}
4848

4949
For more detailed information about section links, see [Section links](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links).
5050

51-
## Relative links and image paths in README files
51+
## Relative links and image paths in markdown files
5252

5353
{% data reusables.repositories.relative-links %}
5454

5555
## Wikis
5656

57-
A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see [AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis).
57+
A README should only contain information necessary for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see [AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis).
5858

5959
## Further reading
6060

0 commit comments

Comments
 (0)