search

breck7 / scrollsdk

Build on top of Scroll.
https://sdk.scroll.pub
380 stars 17 forks source link

💡 Designer: better Readme generation #121

Closed breck7 closed 3 months ago

breck7 commented 3 years ago

"The auto-generated Readme has a lot of wasted space, multiple lines between a section title and its content."

In general it could use a big overhaul.

breck7 commented 3 years ago

https://github.com/treenotation/jtree/issues/120

breck7 commented 3 years ago

Autogenerated readmes from the Grammar don't make sense.

The reason is the odds of the autogenerated readme being the best readme possible are 0%.

Hence, I'm rethinking this as instead of autogenerating a full readme, generating an "Overview" or "Cheat sheet" for a lang from a Grammar.