Hacker News Reader

I continue to be confused about when a README is appropriate for documentation on Github, and when a wiki is preferred, as do my coworkers. (It's a minor bone of contention.)

If you have this many pieces that it's hard to keep straight without a tool like Gutenberg, isn't that modularization the whole idea of a wiki?

View on HN

I like the model of a README that shows high level project structure and common use cases, with links to specific wiki pages for more depth on a topic, and a catch-all top-level wiki link at the end.

Wiki doesn’t download with your repo. I think that’s the reason.

I don’t know. I just don’t feel approriate to use Wiki for projects that are smaller than 6000 LOC, I don’t know.

Maybe you’re right.

You can always put the wiki as a submodule in the git repo since the github wikis are just git repos too:

git clone git@github.com:whatever/whatever.wiki.git

And what is the format of Wiki pages?

GitHub uses Gollum [1] for wikis.

[1]: https://github.com/gollum/gollum/wiki

Reply on news.ycombinator.com