Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from May 15, 2019

Conversation

Projects
None yet
2 participants
@dealingwith
Copy link
Contributor

commented May 12, 2019

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 dealingwith force-pushed the MinecraftU:notes-updates branch 2 times, most recently from ac6bd0a to 8e74001 May 12, 2019

@dealingwith

This comment has been minimized.

Copy link
Contributor Author

commented May 13, 2019

Other non-markdown formatting updates:

  • remove extra carriage returns
  • remove extra spaces between sentences
  • remove "here" in "see here [link]"
  • a couple of grammatical corrections

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?)...

@dealingwith dealingwith marked this pull request as ready for review May 13, 2019

@TheGreyGhost

This comment has been minimized.

Copy link
Owner

commented May 13, 2019

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

This comment has been minimized.

Copy link
Contributor Author

commented May 13, 2019

I'll squash these into a single commit tonight.

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

Change notes.txt files to README.md files
update mbe01_block_simple

update mbe02_block_partial

update mbe03_block_variants

update mbe04_block_dynamic_block_model1

update mbe05_block_dynamic_model2

udpate mbe06_redstone

update mbe08_creative_tab

update mbe10_item_simple

update mbe11_item_variants

update mbe12_item_dbt_animate

update mbe13_item_tools

update mbe14_item_camera_transforms

update mbe15_item_dynamic_item_model

update mbe20_tileentity_data

update mbe21_tileentityspecialrenderer

update mbe30_inventory_basic

update mbe31_inventory_furnance

update mbe35_recipies

update mbe40_hud_overlay

update mbe50_particle

update mbe60_network_messages

update mbe70_configuration

update mbe75_testing_framework

update testingarea

fix nested lists

minor formatting updates

@dealingwith dealingwith force-pushed the MinecraftU:notes-updates branch from 863a499 to d53fe6c May 14, 2019

@dealingwith

This comment has been minimized.

Copy link
Contributor Author

commented May 14, 2019

Ok, squashed into a single commit!

@TheGreyGhost TheGreyGhost merged commit 872f807 into TheGreyGhost:master May 15, 2019

@TheGreyGhost

This comment has been minimized.

Copy link
Owner

commented May 15, 2019

Thanks dude, that's much better.

@dealingwith dealingwith deleted the MinecraftU:notes-updates branch May 16, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.