Bug #9255: README -> README.md

• Status: Closed
• Priority: Normal
• Assignee: zzak (Zachary Scott)
• Target version: 2.6
• ruby -v: 2.1.0dev
• Backport: 1.9.3: DONTNEED, 2.0.0: UNKNOWN

[zzak (Zachary Scott)]

As documentation maintainer, I've decided we will move the README to markdown format and use the '.md' extension.

This change will take effect after the release of 2.1.0

I've outlined my reasoning:

• RDoc now has a built-in markdown parser, writing markdown is much easier
• This change will encourage contributors who are able to read and write markdown
• Github is a large source of new contributors, this change will improve README formatting on github

I will need assistance converting the existing Japanese README.ja to markdown format, any help here is appreciated! Please raise your hand if you'd like to help with the conversion.

[marcandre (Marc-Andre Lafortune)]

:smiley:

[matsuda (Akira Matsuda)]

@zzak (Zachary Scott) Doesn't this just work?
ruby -rrdoc -e "puts RDoc::Markup::ToMarkdown.new.convert(File.read('README.ja'))"

[zzak (Zachary Scott)]

@matsuda (Akira Matsuda) Yes, this should work. Good suggestion!

I would still like someone (native japanese) to verify its correctness.

[zzak (Zachary Scott)]

• Status changed from Assigned to Closed
• % Done changed from 0 to 100

Applied in changeset r44684.

---

• README -> README.md: [DOC] Format README with Markdown [Bug #9255]
• README.ja -> README.ja.md: ditto

[usa (Usaku NAKAMURA)]

• Backport changed from 1.9.3: UNKNOWN, 2.0.0: UNKNOWN to 1.9.3: DONTNEED, 2.0.0: UNKNOWN