News for hackers. Stuff that matters.
Re:Gutenberg: Dynamic README generator with mixins for GitHub by robbfitzsimmons on Saturday October 19, 2013 @02:51PM (#6577358)
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?

Re:Gutenberg: Dynamic README generator with mixins for GitHub by sanderjd on Saturday October 19, 2013 @03:21PM (#6577452)
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.
Re:Gutenberg: Dynamic README generator with mixins for GitHub by svoroval on Saturday October 19, 2013 @02:56PM (#6577376)
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.

Re:Gutenberg: Dynamic README generator with mixins for GitHub by kanzure on Saturday October 19, 2013 @03:29PM (#6577491)
You can always put the wiki as a submodule in the git repo since the github wikis are just git repos too:

git clone [email protected]:whatever/whatever.wiki.git

Re:Gutenberg: Dynamic README generator with mixins for GitHub by straykov on Saturday October 19, 2013 @04:28PM (#6577675)
And what is the format of Wiki pages?
Re:Gutenberg: Dynamic README generator with mixins for GitHub by anton_gogolev on Saturday October 19, 2013 @04:39PM (#6577713)
GitHub uses Gollum [1] for wikis.

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