Tidy up the README a little #930
Conversation
There was a problem hiding this comment.
@sglass68: Thank you for fixing all these grammatical mistakes! I must not have looked very closely before because I didn't realize how many there were. I did leave some comments below with some suggestions, but some are subjective, so feel free to ignore if you disagree.
I'm sorry about the 2-week delay, @vurtun has been busy on other things for quite some time and @dumblob recently had some family issues come up, so this project hasn't had the maintenance attention that it deserves lately.
Readme.md
Outdated
| @@ -93,7 +93,7 @@ nk_end(&ctx); | |||
|
|
|||
| ## Bindings | |||
| There are a number of nuklear bindings for different languges created by other authors. | |||
| I cannot atest for their quality since I am not necessarily proficient in either of these | |||
| I cannot atest for their quality since I am not necessarily proficient in any of these | |||
There was a problem hiding this comment.
@sglass68: Thanks! There's another typo here, "atest" should be "attest"
Readme.md
Outdated
| @@ -2,25 +2,25 @@ | |||
|
|
|||
| [](https://travis-ci.org/vurtun/nuklear) | |||
|
|
|||
| This is a minimal state immediate mode graphical user interface toolkit | |||
| This is a minimal-state immediate-mode graphical user interface toolkit | |||
There was a problem hiding this comment.
@sglass68: I don't think "minimal-state" is typically hyphenated (at least, in a little bit of googling I'm not finding examples of it that way)
There was a problem hiding this comment.
I'm not sure google is going to help much. The way I read it, it is creating an adjective out of a noun (state).
What is this sentence intended to mean? I assumed:
It is a GUI toolkiit
It uses immediate mode
It keeps minimal state internally
'This is a minimal state' probably references to a country ;-)
Perhaps I should have suggested: This is a GUI toolkit which keeps minimal state and operates in immediate mode?
There was a problem hiding this comment.
@sglass68:
it is creating an adjective out of a noun (state)
You're right, good point.
Perhaps I should have suggested: ...
I'm happy either way (though I slightly prefer the minimal-state immediate-mode wording, as it is currently in this PR).
Readme.md
Outdated
| a default render backend or OS window and input handling but instead provides a very modular | ||
| library approach by using simple input state for input and draw | ||
| commands describing primitive shapes as output. So instead of providing a | ||
| embeddable user interface for applications. It does not have any dependencies, |
There was a problem hiding this comment.
@sglass68: This is subjective, but IMO this is better as a single sentence due to the tight semantic connection between the two halves and also to have more variety of sentence length.
Readme.md
Outdated
| `NK_IMPLEMENTATION` in *one* .c/.cpp file before `#include`ing this file, e.g.: | ||
| ```c | ||
| #define NK_IMPLEMENTATION | ||
| #include "nuklear.h" | ||
| ``` | ||
| IMPORTANT: Every time you include "nuklear.h" you have to define the same optional flags. | ||
| This is very important not doing it either leads to compiler errors or even worse stack corruptions. | ||
| This is very important not doing it either leads to compiler errors, or even worse, stack corruptions. |
There was a problem hiding this comment.
@sglass68: I think this also needs a semi-colon or colon to separate "This is very important" from the rest of the sentence.
Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <[email protected]>
Some of the sentences in the README are pretty long and some terms could
do with hyphens. Tidy this up.
Signed-off-by: Simon Glass [email protected]