git2go icon indicating copy to clipboard operation
git2go copied to clipboard

Documentation

Open ethernetdan opened this issue 8 years ago • 5 comments

I've found that I am frequently having to use the libgit2 function reference in order to figure out how to use git2go methods.

It would be great if an effort was made to provide documentation for all methods, large portions could be copied verbatim from libgit2 reference.

ethernetdan avatar Jul 05 '16 18:07 ethernetdan

+1 - Also, as I could see in libgit2sharp project's wiki it is really helpful to provide some gists on how to reproduce some git commands that most users are familiar with.

I have some here that I created for a project that I am working for and I hope that you guys could review and add to this project's wiki git checkout branch - gist
git merge branch - gist

I am not completely sure they are 100% correct, but It seems to work for me and for my current need.

Thanks for this great library! 👍

danielfbm avatar Jul 15 '16 14:07 danielfbm

I usually look at godoc.org/github.com/libgit2/git2go for documentation if that helps.

ktsakas avatar Jul 23 '16 06:07 ktsakas

Do you think it might be worth linking https://godoc.org/github.com/libgit2/git2go in the README? I also would benefit from a simple example of opening a repository. I will see if I can make PR with this.

JamesLMilner avatar May 27 '17 11:05 JamesLMilner

Seems like I am now having an issue with seeing repos of an org I own in git2go despite me owning the org.

AraHaan avatar Jan 01 '18 07:01 AraHaan

I'd also like to see some Examples in the source tree or in the documentation - nothing too extensive, just the five basics: clone, open/pull, add file, commit, push. The fact that git2go is so low level - when compared to others like go-git - makes this doubly necessary imho. The usual sources - okay StackOverflow - aren't that helpful. The "101-Samples" page on the libgit2 site is good, but I'd reorganise it into a more workflow based arrangement.

bluebob avatar Jun 25 '18 07:06 bluebob