Skip to content

Commit 1d3894c

Browse files
committed
converted README to Markdown
1 parent 54e828c commit 1d3894c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Ruby Documentation Project
2+
===========================
3+
4+
This site contains tips, tricks and other information on how to contribute to MRI documentation.
5+
6+
It will have:
7+
8+
* Detailed, step by step contribution guide
9+
* Lists of areas in MRI that are poorly documented or undocumented and should be given high priority
10+
* Current coverage reports
11+
12+
In addition it will sport:
13+
14+
* Links to different resources (tutorials, screencasts, tools) around the topic of submitting documentation patches
15+
* Miscellaneous tips and tricks, such as rebasing a number of commits into one
16+
* Walkthroughs with example documentation patches

0 commit comments

Comments
 (0)