Hard, ill defined problem: Is this README.md any good? - spelling? impossible...

@mistersql

Hard, ill defined problem:

Is this README.md any good?

- spelling? impossible without laborious custom dictionaries
- markdown linting? rarely catches anything interesting
- "required" section headers? Common headers are better for a starter template than as something to ask everyone to do. Impossible to predict applicability
- links ok? yeah, rare problem
- code examples formatted/okay? Yeah, all the same lint/test/etc applies to .py files with worse tooling

Self-replies

- word count? What should it be other than not 0?
- reading level score? Some what dodgy metric and they mostly discourage run on sentences, unclear if they work well on README.md as compared to a 3rd grade chapter book
- Title/Description/Install/Usage? Install is aways "pip install x" what a waste of screen space
- License/Contributing/Security/etc - those probably deserve their own documents or README is 1000s screens tall

I will give it to an LLM and say, "role play this README.md", "Okay, document, are you... good?"