= HAMcast Documentation =

[[PageOutline]]

----

== General ==

 * [http://tools.ietf.org/html/draft-irtf-samrg-common-api API IRTF Draft ]

 * [doxygen:cpp/index.html Documentation for the C++ API]

 * [doxygen:java/index.html Documentation for the Java API]

----

== !HowTos ==

If you have obtained a HAMcast release, follow these instructions to build, configure and run the HAMcast prototype and software tools. All release software parts provide a README file with specific instructions and detailed information. 

 * [wiki:documentation/howto/cmake Build HAMcast]

 * [wiki:documentation/howto/config Configure HAMcast]

 * [wiki:documentation/howto/run Run HAMcast]

'''Note:''' with HAMcast release from ''12-02-13'' we updated our build chain and switched from ''automake'' to ''cmake''. If you want to build a previous prototype release refer to the old build instructions below.


 * [wiki:documentation/howto/build Build HAMcast (old)]

----

== HAMcast Software ==

=== Monitoring Framework ===

 * [wiki:documentation/tools/monitoring/framework Overview on monitoring framework]

 * [wiki:documentation/tools/monitoring README, install monitoring framework]

 * [wiki:documentation/tools/monitoring/rest RESTful interfaces description]

=== Small Tools ===

 * [wiki:documentation/tools/hcchat hc_chat, a simple multicast chat client using HAMcast]

 * [wiki:documentation/tools/hcstatus hc_status, a tool showing HAMcast node status]

 * [wiki:documentation/tools/img img, a configurable Inter-domain Multicast Gateway (IMG)]