threads / patch / 42481

patchREADME.md: format CLI commands with code syntax

Subject: [PATCH] README.md: format CLI commands with code syntax

## tl;dr

3 messages between May 30, 2016 and May 31, 2016. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Benjamin Dopplinger· May 30, 2016, 03:08 UTC · lore

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 <b.dopplinger@gmail.com>
---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
Show changes to README.md +5 −6
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-<commandname>.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-<commandname>` or `git help
+<commandname>`.
 
 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· May 30, 2016, 06:05 UTC · re: Benjamin Dopplinger · lore

Re: [PATCH] README.md: format CLI commands with code syntax

Benjamin Dopplinger <b.dopplinger@gmail.com> writes:
Show 7 quoted lines
> 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 <b.dopplinger@gmail.com>
> ---
>  README.md | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
Looks good to me, thanks.
-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/

← back to recent threads