fantasyland / fantasy-land

Specification for interoperability of common algebraic structures in JavaScript
MIT License
10.08k stars 373 forks source link

readme: reinstate readme and fix automated release workflow #313

Closed davidchambers closed 5 years ago

davidchambers commented 5 years ago

The default behaviour of sanctuary-scripts is to use Transcribe to generate README.md from comments in source code. If the readme is to be maintained by hand, as is the case here, one should disable the default behaviour by including an empty generate-readme executable in the scripts directory. I forgot to do so in #293, so README.md was removed when I published v4.0.0.

This pull request reinstates README.md and adds the missing executable to prevent the problem from happening again. I will merge this pull request then publish v4.0.1.