[PATCH] doc: use markdown syntax in README

David Demelier markand at malikania.fr
Fri Sep 22 13:26:13 UTC 2017


# HG changeset patch
# User David Demelier <markand at malikania.fr>
# Date 1506086724 -7200
#      Fri Sep 22 15:25:24 2017 +0200
# Node ID 274acdd5f4d8d9c68359a99f6caab6efaec415de
# Parent  b90bd9a98c8ba06afdb7f32d434e501d7b3c3929
doc: use markdown syntax in README

Using markdown syntax will have better display in most hosting services
including phabricator.

diff -r b90bd9a98c8b -r 274acdd5f4d8 README
--- a/README	Mon Sep 18 16:01:03 2017 -0700
+++ b/README	Fri Sep 22 15:25:24 2017 +0200
@@ -4,17 +4,17 @@
 Mercurial is a fast, easy to use, distributed revision control tool
 for software developers.
 
-Basic install::
+Basic install:
 
- $ make            # see install targets
- $ make install    # do a system-wide install
- $ hg debuginstall # sanity-check setup
- $ hg              # see help
+    $ make            # see install targets
+    $ make install    # do a system-wide install
+    $ hg debuginstall # sanity-check setup
+    $ hg              # see help
 
-Running without installing::
+Running without installing:
 
- $ make local      # build for inplace usage
- $ ./hg --version  # should show the latest version
+    $ make local      # build for inplace usage
+    $ ./hg --version  # should show the latest version
 
 See https://mercurial-scm.org/ for detailed installation
 instructions, platform-specific notes, and Mercurial user information.


More information about the Mercurial-devel mailing list