Patchwork doc: use markdown syntax in README

login
register
mail settings
Submitter David Demelier
Date Sept. 22, 2017, 1:26 p.m.
Message ID <274acdd5f4d8d9c68359.1506086773@cerise.kehl.dalim.com>
Download mbox | patch
Permalink /patch/24115/
State Rejected
Headers show

Comments

David Demelier - Sept. 22, 2017, 1:26 p.m.
# HG changeset patch
# User David Demelier <markand@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.
Yuya Nishihara - Sept. 25, 2017, 12:53 p.m.
On Fri, 22 Sep 2017 15:26:13 +0200, David Demelier wrote:
> # HG changeset patch
> # User David Demelier <markand@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.

This change disagrees with 76b171209151. Foozy?
David Demelier - Sept. 25, 2017, 1:04 p.m.
On Mon, 2017-09-25 at 21:53 +0900, Yuya Nishihara wrote:
> On Fri, 22 Sep 2017 15:26:13 +0200, David Demelier wrote:
> > # HG changeset patch
> > # User David Demelier <markand@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.
> 
> This change disagrees with 76b171209151. Foozy?
> 


Hmm,

It would be interesting to see which kind of file type is supposed to
be when there is no file extension. It looks like phabricator tries
markdown by default.

So the next question would be, markdown or rst? then we can improve the
readme a little bit more. No matter which kind of syntax we'll use.

Patch

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.