HNGlance

Top Best New Show

Software Packaging Guidelines

https://zorbash.com/post/software-packaging-guidelines/

by zorbash • 10 years ago

4 2 10 years ago

ZO

Related Stories

Loading related stories...

Comments

2

detaro• 10 years ago

Good list, seems to cover many important things that are not language/OS/ecosystem-dependent.

One thing I'd like to add: in your Readme, put information how you can find further documentation (and if it is in the same repo, how it is built). A surprising number of projects have some basic instructions in the readme, and then a /documentation folder or an external website, without any clear reference to it.

zorbash• 10 years ago

I agree, I think I'll update the post with your suggestions.

A common pattern out there, is projects keeping some documentation in their repo's wiki and not mentioning it in the Readme. Unfortunately GitHub does not provide a visual hint on how often a wiki is updated in the repo page.

Source preview

zorbash.com

HNGlance

© 2024-2026 HN Glance. Story content belongs to its original sources.

Privacy
Terms