             aroarfw
           -----------

--- What is aroarfw?:
aroarfw is a framework for using RoarAudio on µControllers.

It is not a complete library to speak the protocol but
a set of consts, types and macros which are very useful while
implementing the protocol.

--- Features:

 * (nearly) all needed magic numbers for the protocol as consts
 * a lot useful types to store the data in. all types are portable
   across the platforms.
 * some nice macros helping you to work with messages and the like.

--- Build:

There is no binary code you need to compile before you can start.

To compile the documentation just type 'doxygen'.

-- Build requirements:

As there is no binary code which needs to be compiled you do not have
any build depends.

However you of cause need the corresponding tool change for using it
on your target platform.

To build the the documentation you need to have 'doxygen' installed.
Please also install all recommends the package may have on your system.
Else the output may not be correct.

-- What is needed on the target platform to be supported?:

The target platform need to support data pointers and be able
to store objects of some bytes in memory at once. The exact memory
usage depends on your application. The target platform should have
at minimum half a KiB of RAM.

In addition the target platform need to provide a stdint.h with
standard 16 and 32 bit integer types. Future versions may require
64 bit types to be present, too.

--- Tested platforms:

OPERATING SYSTEM        ARCH    COMPILER        TESTED  M/STATUS        COMMENT
AND VERSION                                     VERSION
---------------------------------------------------------------------------------------------------
Debian			ix86	gcc 4.1.2	0.1b4	m/OK
Debian Sid		*	*		last	M/OK
-			ATmega	gcc 4.1.0	0.1b0	N/OK

Tested Version:
        Current:        Current as listed on Homepage
        last:           Last released version (This system is on release checklist)
        *b*:            Beta

Status: Maintenance/testing Status:
Maintenance:    s = your are on your own, sources.
                m = package in work, beta package
                M = maintained
                S = maintained source package
                B = maintained binary package
		N = No package because no OS.
		    Crosscompiler used.
		    You can use the package on any
		    other system to build binarys
		    for this arch.
