Proofreading the README

bunyk commented 3 years ago

I wanted to describe make commands to build release and debug versions, because I used debug version since I was trying to figure out the cause of #16 , wanted to create release one, but forgot how. :)

Then I noticed typo in exaple, and to not do a PR with just one typo, decided to add some more improvements:

Proper capitalization of some common proper nouns: Neovim, OpenGL, MacOS, Godot, etc... BTW, I'm not sure if "neoray" should be capitalized. It's a proper noun, so it maybe should, but since it is only capitalized at the start of the sentences, maybe it's your choice as an author to write it lowercase.
Hyperlinks to issues and releases page of the repository
some style and formatting improvements

I could remove some changes you disagree with. I'm myself is not a native English speaker, so my changes probably have more mistakes.

hismailbulut commented 3 years ago

Maybe we also capitalize Neoray. I writed it lowercase because it seemed better to me but now I am thinking that writing all Neoray's capitalized is better. I am also curious about your opinion.

bunyk commented 3 years ago

Well, on the one hand, we have "Vim" and "Neovim", but on the other hand - "vi" and "grep" (probably to have the name match case sensitive command). There are CamelCase names ("GitHub"), and even dromedaryCase examples of names like "iPhone" or "eBay". So anything is equally possible and correct: "Neoray", "neoray", "neoRay", "NeoRay". It's up to the author of the project to choose best name.

hismailbulut commented 3 years ago

I actually end up with Neoray because neoray is not seems better at beginning of sentence and there is also a product named NeoRay. Feel free to change this name. Also thanks for this pr.

hismailbulut / Neoray

Proofreading the README #28