README.md

guitar: libgit2 bindings for R

GUITAR IS PRETTY MUCH NOT WORKING YET

Hi! You're now touring the sausage factory. This notice will disappear once guitar is ready for public consumption.

But I want to try it!

Ok. I'm developing it on a mac. I haven't tested it on Linux, so it's very possibly not going to work there (but feel free to take a stab at fixing it! start at src/entry_points.cpp, and look for the dlopen calls there). I have no idea how dynamic libraries work on Windows, and I currently have no intention on porting guitar to Windows. Please feel free to open an issue so we can discuss submitted patches.

Intro

guitar gives you programmatic access to git in R, through the combined magic of libgit2 and Rcpp.

guitar is meant to be easy to use, with simple classes and methods mapping pretty directly into libgit2's API. If you have a hard time with it, please file documentation issues on github. If you really don't like it, you can alternatively use the chorus to Cake's homonymous song for inspiration :)

Although libgit2 has some of the high-level facilities of the the git command-line tool, most of its API deals in the low-level bits. So if you don't know what the index is, or you can't tell a blob from a ref from a tag, you're probably better off reading Pro Git first (specifically, you'll want to pay attention to chapter 9).

Dependencies

You'll need to install libgit2 with shared library support (this is possibly the default for any sensible installation), you'll need Rcpp, and you'll need boost (I like shared pointers). Since libgit2 is under intense development, stick with the development version (it's what I do, and guitar will chase libgit2's development branch, at least for a while)



cscheid/guitar documentation built on May 12, 2017, 12:23 p.m.