From: "mame (Yusuke Endoh)" <mame@...>
Date: 2012-05-16T22:02:59+09:00
Subject: [ruby-core:45079] [ruby-trunk - Feature #6388] Convert README to README.rdoc with formatting


Issue #6388 has been updated by mame (Yusuke Endoh).


Hello,

nobu (Nobuyoshi Nakada) wrote:
> I'm neutral to change the names, and will rename them if no objections.
> Any thoughts?

I don't like it very much.

README is not for github, but for newbie.
README extensions often represent platform in Unix culture.
".rdoc" may confuse users familiar with Unix but unfamiliar
with Ruby's toolchain.

$ ls perl-5.14.2/README*
perl-5.14.2/README          perl-5.14.2/README.hurd     perl-5.14.2/README.plan9
perl-5.14.2/README.aix      perl-5.14.2/README.irix     perl-5.14.2/README.qnx
perl-5.14.2/README.amiga    perl-5.14.2/README.jp       perl-5.14.2/README.riscos
perl-5.14.2/README.beos     perl-5.14.2/README.ko       perl-5.14.2/README.solaris
perl-5.14.2/README.bs2000   perl-5.14.2/README.linux    perl-5.14.2/README.symbian
perl-5.14.2/README.ce       perl-5.14.2/README.macos    perl-5.14.2/README.tru64
perl-5.14.2/README.cn       perl-5.14.2/README.macosx   perl-5.14.2/README.tw
perl-5.14.2/README.cygwin   perl-5.14.2/README.micro    perl-5.14.2/README.uts
perl-5.14.2/README.dgux     perl-5.14.2/README.mpeix    perl-5.14.2/README.vmesa
perl-5.14.2/README.dos      perl-5.14.2/README.netware  perl-5.14.2/README.vms
perl-5.14.2/README.epoc     perl-5.14.2/README.openbsd  perl-5.14.2/README.vos
perl-5.14.2/README.freebsd  perl-5.14.2/README.os2      perl-5.14.2/README.win32
perl-5.14.2/README.haiku    perl-5.14.2/README.os390
perl-5.14.2/README.hpux     perl-5.14.2/README.os400


Above all, "README.rdoc" is not cool based on my subjective
impression.
It can be configurable on github side, of course?

-- 
Yusuke Endoh <mame@tsg.ne.jp>
----------------------------------------
Feature #6388: Convert README to README.rdoc with formatting
https://bugs.ruby-lang.org/issues/6388#change-26656

Author: zzak (Zachary Scott)
Status: Closed
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: DOC
Target version: 2.0.0


I've moved the current README into README.rdoc and reformatted using rdoc markup. See attached patch.


-- 
http://bugs.ruby-lang.org/