]> git.alsa-project.org Git - alsa-ucm-conf.git/commitdiff
README.md: add installation paragraph
authorJaroslav Kysela <perex@perex.cz>
Fri, 10 Dec 2021 18:29:58 +0000 (19:29 +0100)
committerJaroslav Kysela <perex@perex.cz>
Fri, 10 Dec 2021 18:30:19 +0000 (19:30 +0100)
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
README.md

index c5afd963a7aa600c5a7020e8f2f11886b4262a31..864b1b11f7acb18248f7a824b0adaeb2e70d27da 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,18 @@
 # alsa-ucm-conf
 ## ALSA Use Case Manager configuration
 
+### Installation
+
+Copy the ucm and ucm2 trees to the alsa-lib configuration directory
+(usually located in /usr/share/alsa) including symlinks. The files
+in the package root directory (README.md, LICENSE and VERSION)
+files are extra (only informational).
+
+### Validation
+
 ![Validate UCM configuration](https://github.com/alsa-project/alsa-ucm-conf/workflows/Validate%20UCM%20configuration/badge.svg?branch=master)
 
-The UCM configurations are automatically valited using the UCM validator
+The UCM configurations are automatically validated using the UCM validator
 available at https://github.com/alsa-project/alsa-tests/tree/master/python/ucm-validator .
 
 If you create a pull request for new hardware, please, add also the