libgit-thin: Instalation support
[git/libgit-gsoc.git] / libgit-thin / README
blob652b8d250ebd1ec3ddac798f96a67e1e85348637
1                 libgit-thin: A thin layer on top of GIT
2                 =======================================
4 Welcome!
6 The libgit-thin project aims to create a library which provides a high
7 level and stable API on top of GIT's (internal) low-level library.
9 This should be useful for third party software which needs to retrieve
10 data from GIT repositories, but don't want to fork-exec GIT processes.
12 Currently libgit-thin is under development and is unstable, if you want
13 to try it, please, read the BUGS file and be aware that the API may change.
15 This project is being sponsored by Google, as part of its Summer of Code
16 program. Development takes place at:
18         http://repo.or.cz/w/git/libgit-gsoc.git
20 In order to compile libgit-thin you need to compile GIT first, so in the
21 top directory do:
23 $ make
25 Then enter the libgit-thin directory and compile it:
27 $ cd libgit-thin && make
29 But note that this will also compile the unit-tests, and you'll need
30 libcheck (http://check.sourceforge.net) installed. If you don't want
31 to compile the unit-tests run:
33 $ make libgit-thin.a
35 If you've compiled the unit-tests, you can run them by doing:
37 $ make check
39 To compile the python module (pygit) just do:
41 $ make pygit
43 Additional information regarding the python module can be found
44 in the pygit directory.
46 Author: Luiz Fernando N. Capitulino <lcapitulino@gmail.com>
47 Mentor: Shawn O. Pearce <spearce@spearce.org>