# [PATCH] README.md: format CLI commands with code syntax 3 messages from 2016-05-30 to 2016-05-31. Participants: Benjamin Dopplinger, Matthieu Moy, Junio C Hamano. Thread: https://gitlist.dev/t/42481 ## Benjamin Dopplinger, 2016-05-30 03:08 Subject: [PATCH] README.md: format CLI commands with code syntax Message-ID: <01020154ffa221f6-c45ab36e-cc26-46a8-b2fa-2c40e54959f1-000000@eu-west-1.amazonses.com> URL: https://gitlist.dev/e/01020154ffa221f6-c45ab36e-cc26-46a8-b2fa-2c40e54959f1-000000%40eu-west-1.amazonses.com ``` CLI commands which are mentioned in the readme are now formatted with the Markdown code syntax to make the documentation more readable. Signed-off-by: Benjamin Dopplinger --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2087748..bd8a918 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,14 @@ including full documentation and Git related tools. See [Documentation/gittutorial.txt][] to get started, then see [Documentation/giteveryday.txt][] for a useful minimum set of commands, and -Documentation/git-*commandname*.txt for documentation of each command. +Documentation/git-.txt for documentation of each command. If git has been correctly installed, then the tutorial can also be -read with "man gittutorial" or "git help tutorial", and the -documentation of each command with "man git-*commandname*" or "git help -*commandname*". +read with `man gittutorial` or `git help tutorial`, and the +documentation of each command with `man git-` or `git help +`. CVS users may also want to read [Documentation/gitcvs-migration.txt][] -("man gitcvs-migration" or "git help cvs-migration" if git is +(`man gitcvs-migration` or `git help cvs-migration` if git is installed). The user discussion and development of Git take place on the Git -- https://github.com/git/git/pull/247 ``` ## Matthieu Moy, 2016-05-30 06:05 Subject: Re: [PATCH] README.md: format CLI commands with code syntax Message-ID: URL: https://gitlist.dev/e/vpqbn3odqs9.fsf%40anie.imag.fr In-Reply-To: <01020154ffa221f6-c45ab36e-cc26-46a8-b2fa-2c40e54959f1-000000@eu-west-1.amazonses.com> ``` Benjamin Dopplinger writes: > CLI commands which are mentioned in the readme are now formatted with > the Markdown code syntax to make the documentation more readable. > > Signed-off-by: Benjamin Dopplinger > --- > README.md | 10 +++++----- > 1 file changed, 5 insertions(+), 5 deletions(-) Looks good to me, thanks. -- Matthieu Moy http://www-verimag.imag.fr/~moy/ ``` ## Junio C Hamano, 2016-05-31 15:54 Subject: Re: [PATCH] README.md: format CLI commands with code syntax Message-ID: URL: https://gitlist.dev/e/xmqqzir65iki.fsf%40gitster.mtv.corp.google.com In-Reply-To: ``` Thanks, both.. ```