README.md 970 Bytes
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

Amirouche's avatar
Amirouche committed
18 19
## How to contribute

20 21
The easiest way to start hacking on guile-git is to install
[GNU Guix](https://gnu.org/s/guix) and run the following command:
22 23

```bash
Mathieu Othacehe's avatar
Mathieu Othacehe committed
24
> guix environment -l guix.scm
25 26 27 28
```

You can then:

Amirouche's avatar
Amirouche committed
29
- Create a pull request on gitlab
30
- Send a patch to one of the maintainers
Amirouche's avatar
Amirouche committed
31
- Come and ping `amz3` or `OrangeShark` about it at `#guile@irc.freenode.net`.
32 33

And don't forget to add a unit test!