File	Date	Author	Commit
src	2011-04-30	Nicola Baldo	[49323f] SumEncoder
.hgignore	2011-03-15	Nicola Baldo	[7a63ca] added missing test files
Doxyfile	2011-03-15	Nicola Baldo	[3eef7c] added documentation
Makefile.am	2011-03-14	Nicola Baldo	[600a4b] first release
README	2011-03-15	Nicola Baldo	[3eef7c] added documentation
autogen.sh	2011-03-14	Nicola Baldo	[600a4b] first release
configure.ac	2011-04-30	Nicola Baldo	[49323f] SumEncoder

Read Me

==================================================
   libBiNC - the Binary Network Coding Library
   https://sourceforge.net/projects/libbinc/
==================================================


 Author
----------------------------

Nicola Baldo 
<nicola@baldo.biz>



 What is libBiNC
----------------------------

libBiNC is a library for network coding over binary fields, i.e.,
GF(2). It provides a decoder implementation based on Gaussian
Elimination together with support for developing your own
encoder. Eventually, several encoder implementations might be provided
as well. 




 How to build libBiNC
----------------------------


If you got the source using mercurial (or other version control system), do the following:

./autogen.sh
./configure
make


If you got the source in a .tar.gz, you can skip the first command, i.e., it is sufficient to do:

./configure
make


In both the above cases, you can additionally run the unit tests that ship with libBiNC in the following way:

make check


The API of libBiNC is documented using doxygen. You can generate the doxygen documentation in html format by running doxygen (without parameters) in the root dir of libBiNC. To browse the html documentation generated in this way, point your browser to doc/html/index.html

There are currently no example programs distributed with libBiNC. Please have a look at the API doc as well as the provided test program (in particular decoder-test.cc) to see how this should be done.