TheGreyGhost / MinecraftByExample

Working sample code for the basic concepts in Minecraft and Forge.
Other
1.24k stars 187 forks source link

Suggestion: Convert Notes.txt to README.md #41

Closed kylev closed 6 years ago

kylev commented 6 years ago

Changing from .txt to one of the github-supported rich rendering formats like .md will make the notes easier to read and (probably) more pleasing to search engines. Furthermore, if you name the files README.md, github will auto-render it beneath the directory's file list as people browse the repo on the website.

I'd be willing to help with the conversion/formatting (as a pull request) if you approve a plan.

TheGreyGhost commented 6 years ago

Hi Thanks for the suggestion & the offer of help The notes.txt is just a general notes for me, not really intended for mass consumption. Cheers TGG

real-felix commented 6 years ago

Your note.txt are super useful for me as well! They are definitely more than a private reminder.

Thanks for all this work, by the way. Without it, it would be much more difficult to create a mod from scratch.

TheGreyGhost commented 6 years ago

Thanks mate, you're welcome :)