updated README.markdown

This commit is contained in:
Dmitry Podgorny
2016-04-15 15:56:22 +00:00
parent 9d7b3394e7
commit 838ed493a3

View File

@@ -1,4 +1,5 @@
# libstrophe libstrophe
==========
libstrophe is a lightweight XMPP client library written in C. It has libstrophe is a lightweight XMPP client library written in C. It has
minimal dependencies and is configurable for various environments. It minimal dependencies and is configurable for various environments. It
@@ -10,7 +11,8 @@ Its goals are:
- well documented - well documented
- reliable - reliable
## Build Instructions Build Instructions
------------------
If you are building from a source control checkout, run: If you are building from a source control checkout, run:
@@ -23,9 +25,7 @@ From the top-level directory, run the following commands:
./configure ./configure
make make
This will create a static library, also in the top-level The public API is defined in `strophe.h` which is in the
directory, which can be linked into other programs. The
public API is defined in `strophe.h` which is also in the
top-level directory. top-level directory.
The `examples` directory contains some examples of how to The `examples` directory contains some examples of how to
@@ -41,26 +41,27 @@ another path use the `--prefix` option during configure, e.g.:
./configure --prefix=/usr ./configure --prefix=/usr
## Requirements Requirements
------------
libstrophe requires: libstrophe requires:
- expat or libxml2 - expat is the default; use --with-libxml2 to - expat or libxml2 - expat is the default; use --with-libxml2 to
switch switch
- libresolv on UNIX systems - make sure you include -lresolv - openssl on UNIX systems
if you are compiling by hand.
- libtool - libtool
In addition, if you wish to run the unit tests, you will need the In addition, if you wish to run the unit tests, you will need the
check package. check package.
### OS X (with Homebrew package manager) Installation
------------
You can install libstrophe with: libstrophe package has been added to popular Linux distributions,
BSD systems and OSX package managers.
brew install libstrophe Documentation
-------------
## Documentation
API documentation is inline with the code and conforms to Doxygen API documentation is inline with the code and conforms to Doxygen
standards. You can generate an HTML version of the API documentation standards. You can generate an HTML version of the API documentation