Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Change notes.txt files to README.md files #51
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?)...
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!