summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames O'Shannessy <james.oshannessy@fiberdyne.com.au>2018-10-08 15:10:46 +1100
committerMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-26 17:27:44 +1100
commit13610114b7f283718a678c42e0421c3c51de636e (patch)
tree493b68a56f208f79d7eec4d4a01ff4a6a5a2a309
parent7e4db2ff6865d723a2a6233a9542730876d06260 (diff)
Adding table of for contents for README documentation
Signed-off-by: James O'Shannessy <james.oshannessy@fiberdyne.com.au>
-rw-r--r--README.md11
1 files changed, 1 insertions, 10 deletions
diff --git a/README.md b/README.md
index 3ed571f..fe4a883 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,6 @@
## Alsa Virtual Sound Driver
-The ALSA Virtual Sound Driver (AVIRT) aims to provide a Linux kernel solution to the issue of audio routing in kernel-space, as well as security per-stream, and dynamic configuration of streams at the kernel level.
-
-A top-level abstract dynamic audio driver is presented to the user-space via an ALSA middle-layer card. From there, respective low-level "real" audio drivers can subscribe to it as an "Audio Path".
-
-The top-level driver is configured (currently) using module parameters, as is the norm for sound drivers in the Linux tree, however this will utilise a configfs configuration implementation in future.
-
-A sample dummy Audio Path is provided as an example to show how a low-level audio driver would subscribe to AVIRT, and accept audio routing for playback.
-
-Currently, the Fiberdyne DSP hardmixer is supported on the Renesas R-Car M3 AGL
-reference platform, and a default loopback softmixer is in development.
+[1. Introduction](docs/1. Introduction.md)
## TODO