README.md 1.74 KB
Newer Older
1
# Guile-Git
Amirouche's avatar
Amirouche committed
2

3 4
Guile-Git is a GNU Guile library providing bindings to
[libgit2](https://libgit2.org/).
Amirouche's avatar
Amirouche committed
5

6 7 8 9 10 11 12
Copyright © 2016, 2017 Amirouche Boubekki
Copyright © 2018 Erik Edrosa
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.

13 14
## Documentation

15 16
The documentation is currently a work in progress, so please read the
source and have a look at the [libgit2 API](https://libgit2.org/libgit2/#HEAD).
17

Erik Edrosa's avatar
Erik Edrosa committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
## Installation

Guile-Git uses GNU autotools to create the build and installation
scripts. The default install location is in `/usr/local`. From a
release tarball you can run:

```sh
./configure
make
sudo make install
```

This will install Guile-Git with the prefix `/usr/local/`. This
might not be the default load path for your GNU Guile. You may choose
to change the prefix to your GNU Guile's location with `./configure
--prefix=/usr` or add `/usr/local/` to GNU Guile's load path in your
`.profile` or `.bash_profile` like this (replacing 2.2 with your GNU
Guile major version):

```sh
export GUILE_LOAD_PATH="/usr/local/share/guile/site/2.2${GUILE_LOAD_PATH:+:}$GUILE_LOAD_PATH"
export GUILE_LOAD_COMPILED_PATH="/usr/local/lib/guile/2.2/site-ccache${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_COMPILED_LOAD_PATH"
```

Amirouche's avatar
Amirouche committed
42 43
## How to contribute

44 45
The easiest way to start hacking on guile-git is to install
[GNU Guix](https://gnu.org/s/guix) and run the following command:
46 47

```bash
Mathieu Othacehe's avatar
Mathieu Othacehe committed
48
> guix environment -l guix.scm
49 50 51 52
```

You can then:

Amirouche's avatar
Amirouche committed
53
- Create a pull request on gitlab
54
- Send a patch to one of the maintainers
55
- Come and ping `OrangeShark` about it at `#guile@irc.freenode.net`.
56 57

And don't forget to add a unit test!