ndmitchell / hoogle

Haskell API search engine
http://hoogle.haskell.org/
Other
753 stars 137 forks source link

Cleanup on README.md #371

Closed lambdadog closed 3 years ago

lambdadog commented 3 years ago

You mentioned in #369 that the README could use some love, so I've done my best to clean it up a bit.

Preview of the new README.md

This consists of, largely:

Plus just general cleanup and consistency (ex. being consistent with formatting of code blocks).


Of note are the dead links I removed in the Acknowledgements section.

I found the best fresh links I could for every dead link I removed, but I wasn't which links would be preferred when I found multiple, so just let me know which links would be preferred and I'll add them to the PR:

lambdadog commented 3 years ago

There's definitely more that can be done, especially going into the docs dir a little bit and doing some refactoring, but this is a happy starting point IMO

ndmitchell commented 3 years ago

Thanks, this is great work! I wouldn't worry too much about links for acknowledgements - most of the people there gave suggestions about Hoogle over a decade ago, so not sure it's even a relevant section to keep.