Bug #9255
README -> README.md
| Status: | Closed | ||
|---|---|---|---|
| Priority: | Normal | ||
| Assignee: |  Zachary Scott | ||
| Category: | doc | ||
| Target version: | next minor | ||
| ruby -v: | 2.1.0dev | Backport: | 1.9.3: DONTNEED, 2.0.0: UNKNOWN |
Description
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.
Associated revisions
- README -> README.md: [DOC] Format README with Markdown [Bug #9255]
- README.ja -> README.ja.md: ditto
History
#1
Updated by Marc-Andre Lafortune 3 months ago
:smiley:
#2
Updated by Akira Matsuda 3 months ago
@zzak Doesn't this just work?
ruby -rrdoc -e "puts RDoc::Markup::ToMarkdown.new.convert(File.read('README.ja'))"
#3
Updated by Zachary Scott 3 months ago
@matsuda Yes, this should work. Good suggestion!
I would still like someone (native japanese) to verify its correctness.
#4
Updated by Zachary Scott about 1 month ago
- Status changed from Assigned to Closed
- % Done changed from 0 to 100
#5
Updated by Usaku NAKAMURA about 1 month ago
- Backport changed from 1.9.3: UNKNOWN, 2.0.0: UNKNOWN to 1.9.3: DONTNEED, 2.0.0: UNKNOWN