From 53335cee493865e062e8e51b1f81c84882895038 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 14 Aug 2008 17:45:29 +0200 Subject: add proper documentation --- doc/README.html.in | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 doc/README.html.in (limited to 'doc/README.html.in') diff --git a/doc/README.html.in b/doc/README.html.in new file mode 100644 index 0000000..3c3357e --- /dev/null +++ b/doc/README.html.in @@ -0,0 +1,120 @@ + + + + + +libcanberra @PACKAGE_VERSION@ + + + + +

libcanberra @PACKAGE_VERSION@

+ +

Copyright 2008 Lennart Poettering <@PACKAGE_BUGREPORT@>

+ + + +

License

+ +

This program is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation, either version 2.1 of the +License, or (at your option) any later version.

+ +

This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details.

+ +

News

+ +
Thu 14 Aug +2008:

Version +0.7 released; changes include:

+ +

Overview

+ +

libcanberra is an implementation of +the XDG +Sound Theme and Name Specifications, for generating event sounds +on free desktops. It comes with several backends (ALSA, PulseAudio, +Null) and is designed to be portable. It consists of the following +parts:

+ +
    +
  1. libcanberra: the main library
    2. +
  2. libcanberra-gtk: some glue code to make it easier to use libcanberra from Gtk+ applications
    3. +
  3. libcanberra-gtk-module: a Gtk+ module that uses libcanberra-gtk to trigger input feedback event sounds
    4. +
+ +

For more information see the original announcement.

+ +

Current Status

+ +

libcanberra is mostly feature complete. For now however it +includes backends only for ALSA and PulseAudio.

+ +

libcanberra has been +declared a +blessed GNOME dependency.

+ +

Documentation

+ +

You may browse the gtkdoc +generated programing +documentation of the API.

+ +

Requirements

+ +

Currently, libcanberra is tested on Linux only.

+ +

libcanberra was developed and tested on Fedora Rawhide +from August 2008, it should work on most other Linux +distributions (and maybe Unix versions) since it uses GNU autoconf and +GNU libtool for source code configuration and shared library +management.

+ +

libcanberra has no dependencies besides the OGG Vorbis +development headers and whatever the selected backends require. Gtk+ +support is optional.

+ +

Installation

+ +

As this package is made with the GNU autotools you should run +./configure inside the distribution directory for configuring +the source tree. After that you should run make for +compilation and make install (as root) for installation of +libcanberra.

+ +

Acknowledgements

+ +

None so far.

+ +

Download

+ +

The newest release is always available from @PACKAGE_URL@

+ +

The current release is @PACKAGE_VERSION@

+ +

Get libcanberra's development sources from the GIT repository (gitweb):

+ +
git clone git://git.0pointer.de/libcanberra
+ +

If you want to report bugs or have questions, please use the libcanberra-discuss mailing list.

+ + +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, August 2008
+ + + -- cgit