doc: Fix typos and improve language in README.md

[bernhardkaindl]

I think this is the first PR where the description turned out to be much longer than the diff in the "Files changed" view is. ;-)

• This it's not scary at all, only a few characters here and there!
• I just wanted to ensure you that it's not me/my preference, these are fixes for warnings generated by a tool.

These issues were found by using these LanguageTool extensions for VS Code:

• LTeX: Grammar/Spell Checker Using LanguageTool with Support for LATEX, Markdown, and Others
• Offline Language Provider for English for LanguageTool for Visual Studio Code.

Below are the warning messages from LanguageTool / LTeX extension.

:)

---

• Missing commas after conjunctive/linking adverbs: "In addition," and "Also,".
• Use a comma before 'so' if it connects two independent clauses unless they are closely connected and short
  • (Which but aren't short, so the fix is applied)
• Use "this info" instead of "it" for clarity
• "inside of": This phrase is redundant. Consider using 'inside'
• The verb 'set up' is spelled as two words. The noun 'setup' is spelled as one.
• Multi-process and multithreaded: These are normally spelled as one.

Also, I reworded a sentence which included the sequence "the write" which it warned about with this explanation:
"After 'The', the verb 'write' doesn't fit. If 'write' is the first word in a compound adjective, use a hyphen between the two words. Using the verb 'write' as a noun may be non-standard."

Also, it found a typo and words which need to be capitalized, like Chrome (The proper noun 'Chrome' (= software from Google) needs to be capitalized) which I fixed as well.

---

:)

[namhyung]

Well, sometimes we need long description even for an oneliner. :)

[namhyung]

But I still prefer having a dash.

[bernhardkaindl]

Good, change is reverted now.

[namhyung]

Sorry for the late review. Now it looks good. But can you please add your sign-off in the commit message?

[namhyung]

Also, I think the commit subject can have the 'doc:' prefix instead of 'README.md:'.

[bernhardkaindl]

@namhyung Thanks for the approval, and I updated the commit message as requested. You can merge now.

[namhyung]

It'd be nice to have your real email address in the sign-off line.

[honggyukim]

Hi @bernhardkaindl, good to see you back here again.

It'd be nice to have your real email address in the sign-off line.

@namhyung mentioned the line below.

Signed-off-by: Bernhard Kaindl <43588962+bernhardkaindl@users.noreply.github.com>

I don't think 43588962+bernhardkaindl@users.noreply.github.com is your real email address so please fix it.

[bernhardkaindl]

I don't think 43588962+bernhardkaindl@users.noreply.github.com is your real email address so please fix it.

@honggyukim @namhyung
This is just the standard mail address you make commits on GitHub when your email address is set to private, and as DCO is accepting it, I would not have considered as a problem, it's standard, even in the uftrace commits:

git log|grep -c noreply.github.com
20

However, as I don't want to argue on that a lot, I updated the commit.

[namhyung]

Yeah, it's from old-style email conversations in the kernel community where I used to work on. Probably not needed for github based workflow, but I still prefer seeing real email addresses. Thanks for the update!

[namhyung]

LGTM