From 4ec8b8af1fe5593c08fa5f968d0583e8d2ca62a6 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:54:33 +0100 Subject: [PATCH] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index bbf47dd2..12fbfa97 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -7,7 +7,7 @@ :file:`README.rst` or :file:`README.md` ======================================= -Full documentation contains both a README.rst and a Documentation/Index.rst +Full documentation contains both a :file:`README.rst` and a :file:`Documentation/Index.rst` file. To avoid redundancy in both places, the README.rst in this case usually contains only a summary and links to all aspects of the project, i.e. the VCS repository, the published documentation and - if available - the TYPO3 Extension