Re:I'd like to review your README
by erikerikson on Saturday April 17, 2021 @10:57AM
(#26844669)
You have a point and I might reprioritize.
Specialized terminology allows the communication of complex concepts compactly. For the specialists a brief description like you mentioned is perfect. If you give it first, that person can read it and decide.
It should certainly be followed by a tear down or other plain English explanation of what the thing is.
Kind of like:
```
Brief
A little longer
Be descriptive about the thing
Go into every detail you want to discuss about the thing in the repository...
```
The jargon fooled blurb makes a great "a little longer" and gets out of the way to let the more readable description be given. Burying that can be a pain.
Specialized terminology allows the communication of complex concepts compactly. For the specialists a brief description like you mentioned is perfect. If you give it first, that person can read it and decide.
It should certainly be followed by a tear down or other plain English explanation of what the thing is.
Kind of like: ``` Brief
A little longer
Be descriptive about the thing
Go into every detail you want to discuss about the thing in the repository... ```
The jargon fooled blurb makes a great "a little longer" and gets out of the way to let the more readable description be given. Burying that can be a pain.