README
1# libmesode
2
3libmesode is a fork of libstrophe (http://strophe.im/libstrophe/) for use in Profanity (http://www.profanity.im/).
4
5Reasons for forking:
6
7- Remove Windows support
8- Support only one XML Parser implementation (expat)
9- Support only one SSL implementation (OpenSSL)
10
11This simplifies maintenance of the library when used in Profanity.
12
13Whilst Profanity will run against libstrophe, libmesode provides extra TLS functionality such as manual SSL certificate verification.
14
15Build Instructions
16------------------
17
18If you are building from a source control checkout, run:
19
20 ./bootstrap.sh
21
22to generate the `configure` script.
23
24From the top-level directory, run the following commands:
25
26 ./configure
27 make
28
29The public API is defined in `mesode.h` which is in the
30top-level directory.
31
32The `examples` directory contains some examples of how to
33use the library; these may be helpful in addition to the
34API documentation
35
36To install on your system, as root (or using sudo):
37
38 make install
39
40Note, the default install path is `/usr/local/`, to specify
41another path use the `--prefix` option during configure, e.g.:
42
43 ./configure --prefix=/usr
44
45
README.markdown
1# libmesode
2
3libmesode is a fork of libstrophe (http://strophe.im/libstrophe/) for use in Profanity (http://www.profanity.im/).
4
5Reasons for forking:
6
7- Remove Windows support
8- Support only one XML Parser implementation (expat)
9- Support only one SSL implementation (OpenSSL)
10
11This simplifies maintenance of the library when used in Profanity.
12
13Whilst Profanity will run against libstrophe, libmesode provides extra TLS functionality such as manual SSL certificate verification.
14
15Build Instructions
16------------------
17
18If you are building from a source control checkout, run:
19
20 ./bootstrap.sh
21
22to generate the `configure` script.
23
24From the top-level directory, run the following commands:
25
26 ./configure
27 make
28
29The public API is defined in `mesode.h` which is in the
30top-level directory.
31
32The `examples` directory contains some examples of how to
33use the library; these may be helpful in addition to the
34API documentation
35
36To install on your system, as root (or using sudo):
37
38 make install
39
40Note, the default install path is `/usr/local/`, to specify
41another path use the `--prefix` option during configure, e.g.:
42
43 ./configure --prefix=/usr
44
45