| 1 |
# Guile-GnuTLS README |
| 2 |
|
| 3 |
Guile-GnuTLS provides Guile bindings for the GnuTLS library. |
| 4 |
|
| 5 |
## Documentation |
| 6 |
|
| 7 |
The [Guile GnuTLS |
| 8 |
manual](https://gsasl.gitlab.io/guile-gnutls/manual/) is available in |
| 9 |
different formats, including [one-page HTML Guile-GnuTLS |
| 10 |
manual](https://gsasl.gitlab.io/guile-gnutls/manual/gnutls-guile.html). |
| 11 |
See `doc/`for source code. |
| 12 |
|
| 13 |
## License |
| 14 |
|
| 15 |
Guile-GnuTLS is released under the GNU Lesser General Public License |
| 16 |
(LGPL) version 2.1 or later, see [COPYING.LESSERv2](COPYING.LESSERv2). |
| 17 |
|
| 18 |
Build infrastructure, self-tests and some other files are licensed |
| 19 |
under the GNU General Public License (GPL) version 3 or later, see |
| 20 |
[COPYING](COPYING). |
| 21 |
|
| 22 |
The manual (see doc/) is under the GNU Free Documentation License |
| 23 |
version 1.3 or later, see [doc/fdl-1.3.texi](doc/fdl-1.3.texi). |
| 24 |
|
| 25 |
For any copyright year range specified as YYYY-ZZZZ in this package |
| 26 |
note that the range specifies every single year in that closed interval. |
| 27 |
|
| 28 |
## Build dependencies |
| 29 |
|
| 30 |
To build from tarball you need the following tools: |
| 31 |
|
| 32 |
* [sh](https://www.gnu.org/software/bash/) |
| 33 |
* [make](https://www.gnu.org/software/make/) |
| 34 |
* [Guile](https://www.gnu.org/software/guile/) |
| 35 |
* [GnuTLS](https://www.gnu.org/software/gnutls/) |
| 36 |
* [Texinfo](https://www.gnu.org/software/texinfo/) (optional, for manual) |
| 37 |
* [Texlive & epsf](https://www.tug.org/texlive/) (optional, for manual) |
| 38 |
|
| 39 |
The required software is typically distributed with your operating |
| 40 |
system, and the instructions for installing them differ. Here are |
| 41 |
some hints: |
| 42 |
|
| 43 |
dpkg-based distributions: |
| 44 |
``` |
| 45 |
apt-get install -y make guile-3.0-dev libgnutls28-dev |
| 46 |
``` |
| 47 |
|
| 48 |
rpm-based distributions: |
| 49 |
``` |
| 50 |
yum install -y make guile22-devel gnutls-devel |
| 51 |
``` |
| 52 |
|
| 53 |
On macOS with Xcode and Homebrew: |
| 54 |
``` |
| 55 |
brew install guile gnutls |
| 56 |
``` |
| 57 |
|
| 58 |
## Build instructions |
| 59 |
|
| 60 |
See the |
| 61 |
[INSTALL](https://codeberg.org/gnulib/gnulib/raw/branch/master/doc/INSTALL) |
| 62 |
file for generic instructions, but briefly the following will be |
| 63 |
sufficient to build and install Guile-GnuTLS: |
| 64 |
|
| 65 |
``` |
| 66 |
tar xfz guile-gnutls-*.tar.gz |
| 67 |
cd guile-gnutls-* |
| 68 |
./configure |
| 69 |
make check |
| 70 |
sudo make install |
| 71 |
``` |
| 72 |
|
| 73 |
If you wish to build from git or modify source code, please see the |
| 74 |
file [CONTRIBUTING.md](CONTRIBUTING.md) for more information. |