[PATCH] doc: use markdown syntax in README

FUJIWARA Katsunori foozy at lares.dti.ne.jp
Tue Sep 26 01:14:13 EDT 2017


At Mon, 25 Sep 2017 15:09:32 -0500,
Kevin Bullock wrote:
> 
> > On Sep 25, 2017, at 08:04, David Demelier <markand at malikania.fr> wrote:
> > 
> > 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 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.
> >> 
> >> 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.
> 
> As a project we favor rST. We could rename the file README.rst maybe? Would that be sufficient to kick Phabricator into DTRT with displaying it?
> 

I'm +1 to renaming the file README.rst, too (though I'm not sure that
Phabricator can handle README.rst as expected) It will help other
hosting services to detect kind of syntax.


> pacem in terris / мир / शान्ति / ‎‫سَلاَم‬ / 平和
> Kevin R. Bullock
> 
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel at mercurial-scm.org
> https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel

-- 
----------------------------------------------------------------------
[FUJIWARA Katsunori]                             foozy at lares.dti.ne.jp


More information about the Mercurial-devel mailing list