README
1libstrophe [](https://travis-ci.org/strophe/libstrophe)
2==========
3
4libstrophe is a lightweight XMPP client library written in C. It has
5minimal dependencies and is configurable for various environments. It
6runs well on Linux, Unix and Windows based platforms.
7
8libstrophe is dual licensed under MIT and GPLv3.
9
10Build Instructions
11------------------
12
13If you are building from a source control checkout, run:
14
15 ./bootstrap.sh
16
17to generate the `configure` script.
18
19From the top-level directory, run the following commands:
20
21 ./configure
22 make
23
24The public API is defined in `strophe.h` which is in the
25top-level directory.
26
27The `examples` directory contains some examples of how to
28use the library; these may be helpful in addition to the
29API documentation
30
31To install on your system, as root (or using sudo):
32
33 make install
34
35Note, the default install path is `/usr/local/`, to specify
36another path use the `--prefix` option during configure, e.g.:
37
38 ./configure --prefix=/usr
39
40### Android
41
42Run script `build-android.sh` and follow the instructions. You will
43need expat sources and android-ndk.
44
45Requirements
46------------
47
48libstrophe requires:
49
50- expat or libxml2 - expat is the default; use --with-libxml2 to
51 switch
52- openssl on UNIX systems
53
54To build libstrophe using autotools you will need autoconf, automake,
55libtool and pkg-config.
56
57Installation
58------------
59
60libstrophe package has been added to popular Linux distributions,
61BSD systems and OSX package managers.
62
63Documentation
64-------------
65
66API documentation is inline with the code and conforms to Doxygen
67standards. You can generate an HTML version of the API documentation
68by running:
69
70 doxygen
71
72Then open `docs/html/index.html`.
73
README.markdown
1libstrophe [](https://travis-ci.org/strophe/libstrophe)
2==========
3
4libstrophe is a lightweight XMPP client library written in C. It has
5minimal dependencies and is configurable for various environments. It
6runs well on Linux, Unix and Windows based platforms.
7
8libstrophe is dual licensed under MIT and GPLv3.
9
10Build Instructions
11------------------
12
13If you are building from a source control checkout, run:
14
15 ./bootstrap.sh
16
17to generate the `configure` script.
18
19From the top-level directory, run the following commands:
20
21 ./configure
22 make
23
24The public API is defined in `strophe.h` which is in the
25top-level directory.
26
27The `examples` directory contains some examples of how to
28use the library; these may be helpful in addition to the
29API documentation
30
31To install on your system, as root (or using sudo):
32
33 make install
34
35Note, the default install path is `/usr/local/`, to specify
36another path use the `--prefix` option during configure, e.g.:
37
38 ./configure --prefix=/usr
39
40### Android
41
42Run script `build-android.sh` and follow the instructions. You will
43need expat sources and android-ndk.
44
45Requirements
46------------
47
48libstrophe requires:
49
50- expat or libxml2 - expat is the default; use --with-libxml2 to
51 switch
52- openssl on UNIX systems
53
54To build libstrophe using autotools you will need autoconf, automake,
55libtool and pkg-config.
56
57Installation
58------------
59
60libstrophe package has been added to popular Linux distributions,
61BSD systems and OSX package managers.
62
63Documentation
64-------------
65
66API documentation is inline with the code and conforms to Doxygen
67standards. You can generate an HTML version of the API documentation
68by running:
69
70 doxygen
71
72Then open `docs/html/index.html`.
73
){kind=link}