From 7b8c329578d642d31618d487b97864306c43073c Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sat, 17 Jul 2004 14:06:13 +0000 Subject: add documentation git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@86 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/README.html.in | 133 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 133 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 00000000..a9b07d60 --- /dev/null +++ b/doc/README.html.in @@ -0,0 +1,133 @@ + + + + + +polypaudio @PACKAGE_VERSION@ + + + + +

polypaudio @PACKAGE_VERSION@

+ +

Copyright 2002-2004 Lennart Poettering <@PACKAGE_BUGREPORT@>

+ + + +

License

+ +

This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License as +published by the Free Software Foundation; either version 2 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 +General Public License for more details.

+ +

You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

+ +

News

+ + +
Sat Jul 17 2004:

Version 0.1 released

+ +

Overview

+ +

polypaudio is a sound server for Linux and other Unix like +operating systems. It is intended to be an improved drop-in +replacement for the Enlightened Sound +Daemon (ESOUND). In addition to the features ESOUND provides +polypaudio has:

+ + + +

Both the core and the client API are completely asynchronous making +use of a simple main loop abstraction layer. This allows easy +integration with asynchronous applications using the +glib/gtk mainloop. Since the asynchronous API +available through polyplib is quite difficult to use there is +a simplified synchronous API wrapper polyplib-simple +available.

+ +

Status

+ +

Version @PACKAGE_VERSION@ is quite usable. polypaudio does +not yet match all ESOUND features: currently a sample cache and +automatic releasing of unused sound drivers are missing. Have a look on the more extensive TODO list.

+ +

Documentation

+ +

There is some prelimenary documentation available: modules.html, cli.html, daemeon.html.

+ +

Documentation for developing with polypaudio is not yet +available. Read the source, Luke!

+ +

Requirements

+ +

Currently, polypaudio is tested on Linux only. It requires an OSS or ALSA compatible soundcard.

+ +

polypaudio was developed and tested on Debian GNU/Linux +"testing" from July 2004, 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.

+ +

polypaudio needs Secret Rabbit Code (aka libsamplerate) and alsa-lib.

+ +

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 +polypaudio.

+ +

Acknowledgements

+ +

Eric B. Mitchell for writing ESOUND

+ +

Download

+ +

The newest release is always available from @PACKAGE_URL@

+ +

The current release is @PACKAGE_VERSION@

+ +

Get polypaudio's development sources from the Subversion repository. (viewcvs)

+ +

If you want to be notified whenever I release a new version of this software use the subscription feature of Freshmeat.

+ +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, July 2004
+
$Id$
+ + + -- cgit