/* Copyright (c) 2007 Axel Wachtler
   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   * Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
   * Neither the name of the authors nor the names of its contributors
     may be used to endorse or promote products derived from this software
     without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   POSSIBILITY OF SUCH DAMAGE. */

/* $Id: main.dox,v 1.12 2010/12/16 06:26:04 awachtler Exp $ */

/**
 @mainpage @uracoli Manual

 \uracoli stands for <em><b>microcontroller radio communications
 library</b></em> and is a package that demonstrates the capabilities and
 usage of Atmels IEEE-802.15.4 radio transceivers AT86RF{230,231,212} in
 combination with Atmels AVR microcontrollers ATmega{1281,16}, ATtiny{44,84}
 and others.

 Currently \uracoli contains low level driver routines for operating
 the radio transceivers, e.g. configuring transceiver parameters like
 RF channel and TX output power, doing CSMA/CA and sending and receiving frames.
 These functions are available in the library @libradio.

 In order to create simple demo applications, \uracoli provides also a set
 of helper functions for host interface communication, timer control and
 general purpose IO control, which are available in the library @libio.

 Because there are several different @ref pgBoards "variants of hardware platforms", \uracoli
 provides a platform abstraction concept, which allows the easy
 definition and integration of new hardware into the project.

 This Manual conains the following sections:

  - @subpage pgUracoliIntro\n
    <em>How to start with uracoli?</em>
  - @subpage pgUsrMain\n
    <em>The library reference manual.</em>
 \if NEWDOC
  - @subpage pgBoards\n
    <em>The board reference list.</em>
  - @subpage pgXmpl\n
    <em>The list of examples.</em>
 \endif
  - @subpage pgXmplMain\n
    <em>A set of simple examples.</em>
  - @subpage pgAppMain\n
    <em>Out of the box applications like wireless uart, sniffer, ...</em>
  - @subpage pgContribMain\n
    <em>Projects that shows the firmware in combination with PC software</em>
  - @subpage pgDevMain\n
    <em>Detailed information about the development process.</em>

 All software and documentation provided here, is released under the
 terms of the @subpage pgMainLicense "Modified BSD license".

 @subpage pgAck "Acknowledgements" for various contributions are stated here.

 An overview about the package version you can find @subpage pgMainReleases "here".

*/

/**
 @page pgMainLicense License and Copyright

<pre>
\htmlinclude "LICENSE"
</pre>

 */

/**
 @page pgMainReleases Release Notes

<pre>
\htmlinclude "RELEASENOTES"
</pre>

 */
