Add wiki and/or examples directory to source

libgit2 / rugged

ruby bindings to libgit2

MIT License

2.25k stars 277 forks source link

Add wiki and/or examples directory to source #538

Open apeiros opened 9 years ago

apeiros commented 9 years ago

There are a couple of things which are not that easy to figure from plain API docs. A wiki and/or an "examples" directory in the source would help a lot with that. Could also help to have a way to see how to do something "the proper way".

arthurschreiber commented 9 years ago

See https://github.com/libgit2/rugged/pull/294. I'll put on some polish and get that merged.

apeiros commented 9 years ago

Oh dear, I actually have seen this issue, clicked through to the libgit2 examples and forgot to check the ported examples. Shame on me :-S What about a wiki-page, though?

arthurschreiber commented 9 years ago

Mh. libgit2sharp has this: https://github.com/libgit2/libgit2sharp/wiki/LibGit2Sharp-Hitchhiker's-Guide-to-Git but I'm wondering whether something similar would be overkill?