[PATCH] README.md: format CLI commands with code syntax
- From
- Benjamin Dopplinger <b.dopplinger@gmail.com>
- Date
- May 30, 2016, 03:08 UTC
- Message-ID
- <01020154ffa221f6-c45ab36e-cc26-46a8-b2fa-2c40e54959f1-000000@eu-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 <b.dopplinger@gmail.com> --- 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-<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