Better Documentation (Quickstart)

[kaylarose]

Objective-Git should really have a 5-minute quickstart to using the Objective-Git framework in an new/existing XCode project. The framework article linked to in the README is okay as a generic guide to frameworks, but not really for using Objective-Git specifically.

For Instance:

• Drag X to Linked Frameworks

• Modify Y build settings in the target Info Window

• Link Z dependencies

• Etc. Etc. Etc.

  #import <ObjectiveGit/ObjectiveGit.h>
  

Other examples of good Quickstarts:

• http://brandonwalkin.com/bwtoolkit/ (install guide section)
• https://github.com/geoffgarside/Git.framework

[brianmichel]

This would be great to have! This sounds like something that could/would go onto the wiki as well.

[patchthecode]

It would be really nice if there was some simple sample project that demonstrates

1. a clone
2. a push
3. a pull
   How does this all work? Documentation? (maybe i'm looking in the wrong places)

[jspahrsummers]

@patchthecode As mentioned in #46, none of those are currently supported.

[schwa]

It would be really nice if the README for Objective-Git spells out what this framework can and can't do.

[jspahrsummers]

@schwa The capabilities of ObjectiveGit are inherited from libgit2, and change fairly rapidly. We definitely need some better docs, but that information is probably most easily accessed in header documentation.

[schwa]

Well maybe in broad strokes. For example I wasted a good chunk of time before I realised that obj-git doesn't support push/pull, etc. Maybe posting the objectives of what the project will do and what it won't do?

[jspahrsummers]

I wasted a good chunk of time before I realised that obj-git doesn't support push/pull, etc.

This is just from being behind libgit2 right now, but there's already work going on (e.g. #224) to remedy that.

Maybe posting the objectives of what the project will do and what it won't do?

That's a good idea. We should definitely list the goals somewhere.

[angkec]

Looking to add git support in my project however the only code snippets I can find is the clone code in the sample app. Are there any other docs/tutorials any one can point me to? I'm looking to do simple fetch/merge and pushes. Thanks!

[phatblat]

@angkec make sure to check out the tests, there are some great examples in there.

[angkec]

Thanks Ben!

On Tue, Dec 23, 2014 at 10:21 AM, Ben Chatelain notifications@github.com
wrote:

@angkec https://github.com/angkec make sure to check out the tests
https://github.com/libgit2/objective-git/tree/master/ObjectiveGitTests,
there are some great examples in there.

Reply to this email directly or view it on GitHub
#30 (comment)
.

[angkec]

So by reading the tests and cross-referencing with pygit2 I successfully got objective-git to fetch, merge, commit and push. I will be documenting the code in my personal kb. However I think the code will be very helpful for any new comers to objective-git. Is this repository interested in hosting the code snippets as tutorials?

[jspahrsummers]

@angkec ObjectiveGit is still undergoing a lot of churn (because libgit2 is not stable either), and Swift has thrown a new wrench into things as well. Any sample code will invariably get out of date pretty quickly, so I don't think we'd want to save it here.

Thank you for the offer, though! ✨

[angkec]

No way, are you saying my code will break in the future? JK. Thanks for the
wonderful work on the library!

On Mon, Dec 29, 2014 at 9:48 PM, Justin Spahr-Summers <
notifications@github.com> wrote:

@angkec https://github.com/angkec ObjectiveGit is still undergoing a
lot of churn (because libgit2 is not stable either), and Swift has
thrown a new wrench into things as well. Any sample code will invariably
get out of date pretty quickly, so I don't think we'd want to save it here.

Thank you for the offer, though! [image: ✨]

Reply to this email directly or view it on GitHub
#30 (comment)
.

[phatblat]

Resolved with #503