5 ms·

I just want to point out that while the author apologizes for his poor English, the entire github README actually explains the motivation, history and high-leve

I just want to point out that while the author apologizes for his poor English, the entire github README actually explains the motivation, history and high-level architecture very clearly. I wish more projects covered all those points on their landing pages.

RMPR 7y ago
Is the README a landing page? I prefer a separate blog post with all that, to keep the README as concise as possible. Like this: https://telegra.ph/Announcing-atbswp-a-minimalist-keyboard-macro-recording-and-playback-tool-03-16 https://telegra.ph/Announcing-atbswp-a-minimalist-keyboard-m... Disclaimer: I wrote that.
- arka2147483647 7y ago
  > Is the README a landing page? Well, yes? Isnt that whats it for? Also, blogs will be lost to the sands of time, while readme will survive as long as someone has the sources.
  - RMPR 7y ago
    I get your point but I'm arguing that a blog is more expressive when talking about things like project history and whatnot.
j-james 7y ago
I find it interesting how often I observe someone give a disclaimer about being bad at English, followed up with the clearest explanation / documentation / answer I've seen in a good month or so.
- read_if_gay_ 7y ago
  Probably because they put in more effort.
- pbhjpbhj 7y ago
  Possibly you have to be really good at a language to realise how "bad" you are. If you're poor at using a language you can't see your mistakes. As you become significantly better you can appreciate nuance, and such, and again feel inferior.
  - 83457 7y ago
    Too good for someone to realize you are a non-native speaker, and not good enough to not occasionally make obvious mistakes without realizing it.
bilegeek 7y ago
His documentation in general is top-notch, especially the included PDF.
cuddlybacon 7y ago
I wonder if as people get sufficiently good at a second language, particularly on the internet, people become more willing to nitpick.

RMPR 7y ago

Is the README a landing page? I prefer a separate blog post with all that, to keep the README as concise as possible. Like this: https://telegra.ph/Announcing-atbswp-a-minimalist-keyboard-macro-recording-and-playback-tool-03-16 https://telegra.ph/Announcing-atbswp-a-minimalist-keyboard-m... Disclaimer: I wrote that.

arka2147483647 7y ago
> Is the README a landing page? Well, yes? Isnt that whats it for? Also, blogs will be lost to the sands of time, while readme will survive as long as someone has the sources.
- RMPR 7y ago
  I get your point but I'm arguing that a blog is more expressive when talking about things like project history and whatnot.

j-james 7y ago

I find it interesting how often I observe someone give a disclaimer about being bad at English, followed up with the clearest explanation / documentation / answer I've seen in a good month or so.

read_if_gay_ 7y ago
Probably because they put in more effort.
pbhjpbhj 7y ago
Possibly you have to be really good at a language to realise how "bad" you are. If you're poor at using a language you can't see your mistakes. As you become significantly better you can appreciate nuance, and such, and again feel inferior.
- 83457 7y ago
  Too good for someone to realize you are a non-native speaker, and not good enough to not occasionally make obvious mistakes without realizing it.

bilegeek 7y ago

His documentation in general is top-notch, especially the included PDF.

cuddlybacon 7y ago

I wonder if as people get sufficiently good at a second language, particularly on the internet, people become more willing to nitpick.