summaryrefslogtreecommitdiffstats
path: root/doc/README.html.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.html.in')
-rw-r--r--doc/README.html.in25
1 files changed, 24 insertions, 1 deletions
diff --git a/doc/README.html.in b/doc/README.html.in
index a9b07d60..b523e3dc 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -78,7 +78,10 @@ available.</p>
<p>Version @PACKAGE_VERSION@ is quite usable. <tt>polypaudio</tt> 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 <a href="http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/src/todo?view=markup">TODO list</a>.</p>
+automatic releasing of unused sound drivers are missing. Have a look
+on the more extensive <a
+href="http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/doc/todo?view=markup">TODO
+list</a>.</p>
<h2><a name="documentation">Documentation</a></h2>
@@ -90,6 +93,26 @@ href="daemon.html"><tt>daemeon.html</tt></a>.</p>
<p>Documentation for developing with <tt>polypaudio</tt> is not yet
available. Read the source, Luke!</p>
+<h3>First Steps</h1>
+
+<p>Simply start the polypaudio daemon with the argument <tt>-C</tt></p>
+
+<pre>polypaudio -C</pre>
+
+<p>This will present you a screen like this:</p>
+
+<pre>Welcome to polypaudio! Use "help" for usage information.
+&gt;&gt;&gt; </pre>
+
+<p>Now you can issue CLI commands as described in <a
+href="cli.html"><tt>cli.html</tt></a>. Another way to start
+<tt>polypaudio</tt> is by specifying a configuration script on the
+command line like that one included in the distribution:</p>
+
+<pre>polypaudio -F polypaudio.pa</pre>
+
+<p>This will load some drivers and protocols automatically.</p>
+
<h2><a name="requirements">Requirements</a></h2>
<p>Currently, <tt>polypaudio</tt> is tested on Linux only. It requires an OSS or ALSA compatible soundcard.</p>