search

TheGreyGhost / MinecraftByExample

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

Change notes.txt files to README.md files #51

Closed dealingwith closed 5 years ago

dealingwith commented 5 years ago

Updates the notes files in each section folder to README.md files that will display nicely in GitHub.

Also updates some formatting to be more markdowny.

dealingwith commented 5 years ago

Other non-markdown formatting updates:

I tried to make as few changes as possible that might impact the meaning of the text. My goal is simply readability, specifically on GitHub.

Background: We (Minecraft U) are hoping to use a bunch of these examples in our Java modding curriculum, either straight-up or adapting them for our audience (late elementary and middle-school students). We'll probably use the GitHub repository directly (our fork) and just have them read straight from the GitHub pages. These changes will make that easier.

@TheGreyGhost the question is, are these changes useful to you, and/or work with your process of documenting these examples?

I also know the diffs here aren't helpful to see what changes were made, as I had to rename the files first. I've used separate commits for each section for now, but assume you'll want me to squash into a single commit should you accept these changes.

I'm also probably going to open a separate PR for updates to the main README and ReadMeFirst.txt (they seem redundant?)...

TheGreyGhost commented 5 years ago

Howdy

Keen, thanks for these!

I'll review them in the next day or so and (more likely than not) merge them straight in.

I'm about to start work on this again after a long break... fix a couple of bugs and then update for 13 including updating the various notes (some of the hints/tips are probably broken/out of date now)

If you are keen to contribute in other ways eg further examples or fixing problems with these examples, you'd be very welcome!

Cheers TGG

dealingwith commented 5 years ago

I'll squash these into a single commit tonight.

I certainly hope we'll be able to contribute further!

dealingwith commented 5 years ago

Ok, squashed into a single commit!

TheGreyGhost commented 5 years ago

Thanks dude, that's much better.