rpgtkoolmv / corescript

http://www.rpgmakerweb.com/products/programs/rpg-maker-mv
MIT License
311 stars 74 forks source link

Polishing README.md (and possibly other docs) #85

Closed JALowther closed 7 years ago

JALowther commented 7 years ago

I've edited the first part of the documentation here to improve clarity and readability, including making it easier to understand for less technically-inclined users who wish to test the new Corescripts via the release builds (I'd like to go further with a more in-depth step by step in order to get 1.1x into the hands of more testers).

Please understand that I don't mean to insult you with these changes. This is very well written for someone with English as a second language, and I would like to offer my assistance in helping to polish this and future documentation as well. :)

If you like the idea, I will return to finish refining the remainder of the document at a later time. I love RPG Maker MV and I've written several software manuals in the past as I do this professionally, so this is the best way I can contribute.

JALowther commented 7 years ago

Hmm, I should look further into things like that before trying to do any editing then.

ghost commented 7 years ago

@JALowther it seems ok otherwise, it was just a minor nitpick. Please don't shy away from polishing the text because of that minor issue!!

JALowther commented 7 years ago

Oh, it's not just that (please don't feel bad).

After I did these edits, it occurred to me that there were a few things I'd need to ask for clarification on from the developers...and then it occurred to me that this would be counter productive as I'd be taking up more of their already valuable time. :\

The docs will be okay as they are. It would take someone with a better technical grasp than I have in order to touch these up without having to pester the devs about clarifying things so I had best leave them be.

ghost commented 7 years ago

@JALowther sure, but you should at least go ahead and keep this README.md pull request. You're not really touching any technical topics (apart from the place I mentioned, where I already suggested you a correction) and it seems like a worthy improvement.

As for the docs, I can't comment for the developers but there are people around like me who still have a good grasp on the core script source code (I'm a plugin developer mainly, so I have dug through a lot of it in my freetime) and who can help you with this as well. While I guess if you really have no idea of any technical details that might be a problem, if you just have some occasional gap you can't decipher from the code then it's probably not as much of an issue as you think.

If in doubt I'd rather suggest you do pull requests for various texts. If it has a lot of problematic points people will tell you, and then you can still decide it's probably not worth the effort.

krmbn0576 commented 7 years ago

@JALowther Hi, we are not good at English, so your contribution is very appreciated! 😇 Would you please reopen this pull request? If you have any questions on revision, please ask me :-)