Fix bytevector->hex-string.
[guile-toxcore.git] / README.md
CommitLineData
8b8abc35
DT
1guile-toxcore
2=============
3
4Guile Scheme bindings for [libtoxcore](https://github.com/irungentoo/toxcore).
5
6Usage
7-----
8
c49c3b77
DT
9There are 2 ways to use guile-toxcore. The `(tox)` module exports a
10high-level API that performs error checking and abstracts away the handling of
11foreign data types and pointers. This is almost certainly the API that you
12want to use. However, if you desire to build up your own abstractions on top
13of the low-level C bindings or the high level bindings do not do what you
14want, use the `(tox bindings)` module.
15
16To use the high-level API:
17
8b8abc35
DT
18```
19(use-modules (tox))
20
c49c3b77
DT
21(with-tox (make-tox)
22 ;; TODO: Call your friend to ask if they've read their SICP today.
23 (display "Hello, Tox!\n"))
24```
25
26To use the low-level API:
27
28```
29(use-modules (tox bindings))
8b8abc35 30
c49c3b77 31(define tox (tox-new 1))
8b8abc35
DT
32
33(tox-kill tox)
34```
35
36Dependencies
37------------
38
39* libtoxcore
40* GNU Guile >= 2.0.5
41
42Install
43-------
44
45```
de0591e8 46./autogen.sh &&
8b8abc35
DT
47./configure &&
48make &&
49sudo make install
50```
51
52License
53-------
54
55Copyright © 2014 David Thompson <davet@gnu.org>
56
57guile-toxcore is free software: you can redistribute it and/or modify it under
58the terms of the GNU General Public License as published by the Free Software
59Foundation, either version 3 of the License, or (at your option) any later
60version.
61
62guile-toxcore is distributed in the hope that it will be useful, but WITHOUT
63ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
64FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
65details.
66
67You should have received a copy of the GNU General Public License along with
68this program. If not, see <http://www.gnu.org/licenses/>.