<!--

    Copyright (c) 2009-2016 Wilfred Springer

    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use,
    copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following
    conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    OTHER DEALINGS IN THE SOFTWARE.

-->
<article>
  <title>README</title>
  <subtitle><?eval ${project.version}?></subtitle>
  <para>
    <?eval ${project.description}?>
  </para>
  <bridgehead>Current Status</bridgehead>
  <para>
    <?eval ${project.name}?> is not released yet. There are a couple
    of known issues that will have to be resolved, and some interface
    choices that need to be clarified. Version 1.0 of Preon is
    expected to be released in Q1 2009.
  </para>
  <bridgehead>Limitations</bridgehead>
  <para>
    Not listed here, until version 1.0 is released.
  </para>
  <bridgehead>Contents</bridgehead>
  <para>
    The binary distribution of <?eval ${project.name}?> includes two
    Preon libraries in<filename>lib</filename>.
  </para>
  <variablelist>
    <varlistentry>
      <term>
        <filename>preon-bitbuffer-<?eval ${project.version}?>.jar</filename>
      </term>
      <listitem>
        <para>
          The library providing a ByteBuffer-alike abstraction for
          accessing potentially non-byte-aligned sequences of bits,
          and a number of implementations.
        </para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <filename>preon-binding-<?eval ${project.version}?></filename>
      </term>
      <listitem>
        <para>
          The library providing the classes, interfaces and
          annotations for binding a Java-based data structure to a
          binary encoded representation.
        </para>
      </listitem>
    </varlistentry>
  </variablelist>
  <para>
    The directory
    <filename>lib/ext</filename>
    includes additional
    libraries that may be required to use <?eval ${project.name}?>,
    depending on your needs.
  </para>
  <para>
    The directory
    <filename>doc</filename>
    includes a number of PDF
    documents that will hopefully some grow into a full manual. It
    also includes the Javadoc documentation of all Preon classes and
    interfaces.
  </para>
  <bridgehead>License</bridgehead>
  <para>
    <?eval ${project.name}?> is licensed under an MIT License.
  </para>
  <bridgehead>Distribution</bridgehead>
  <para>
    The full distribution of <?eval ${project.name}?> can be
    downloaded from<ulink
          url="http://sourceforge.net/projects/preon/"/>. However, it may be
    easier to point Maven to the snapshot repository, at<ulink
          url="http://preon.sourceforge.net/snapshots/"/>. You are allowed
    to distribute <?eval ${project.name}?> through a Maven repository.
  </para>
</article>