Ask HN: What are the best GitHub READMEs you've seen?

#1

Post by yammesicka » Tue, Aug 02, 2022, 4:24 PM UTC

No post body was provided.

Re: Ask HN: What are the best GitHub READMEs you've seen?

#2

Post by there4 » Tue, Aug 02, 2022, 4:42 PM UTC

The table layout and example formatting of "The Universal Route Module API Specification" is quite good: https://github.com/fastify/fastify-dx/blob/main/URMA.md

Re: Ask HN: What are the best GitHub READMEs you've seen?

#3

Post by ezekg » Tue, Aug 02, 2022, 4:44 PM UTC

there4 wrote: post #2

The table layout and example formatting of "The Universal Route Module API Specification" is quite good: https://github.com/fastify/fastify-dx/blob/main/URMA.md

Table layouts are cool on desktop, but they suck on mobile.

Re: Ask HN: What are the best GitHub READMEs you've seen?

#4

Post by cyberge99 » Tue, Aug 02, 2022, 6:04 PM UTC

This one is pretty neat:

https://github.com/esatterwhite

It's not an app README, but a profile one. A lot of it is done with images.

Re: Ask HN: What are the best GitHub READMEs you've seen?

#5

Post by JoeyBananas » Tue, Aug 02, 2022, 6:10 PM UTC

Vimspector

Re: Ask HN: What are the best GitHub READMEs you've seen?

#6

Post by alexvoda » Wed, Aug 03, 2022, 7:26 AM UTC

ezekg wrote: post #3

there4 wrote: post #2

The table layout and example formatting of "The Universal Route Module API Specification" is quite good: https://github.com/fastify/fastify-dx/blob/main/URMA.md

Table layouts are cool on desktop, but they suck on mobile.

The link above, after switching to desktop mode on Chrome on Android looks fine.