summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Dopplinger <b.dopplinger@gmail.com>2016-05-30 03:08:16 +0000
committerJunio C Hamano <gitster@pobox.com>2016-05-31 08:54:24 -0700
commita299e3a39619dc5e05790d0cc06d8336e7c3d756 (patch)
treed678d5b64cd51c1f86e6e6369b91edaba8c8177b
parentf3913c2d03abc660140678a9e14dac399f847647 (diff)
downloadgit-a299e3a39619dc5e05790d0cc06d8336e7c3d756.tar.gz
README.md: format CLI commands with code syntaxbd/readme.markdown-more
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> Reviewed-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 2087748f0c..bd8a918a9b 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