Skip to content

Commit 1839bae

Browse files
tools/plugin: Fix broken README.md
This commit corrects the heading formatting in the SOF ALSA plugin README by properly using `#`, `##`, and `###` where needed. This ensures consistency and proper Markdown rendering. Signed-off-by: Suraj Sonawane <surajsonawane0215@gmail.com>
1 parent 9228f20 commit 1839bae

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

tools/plugin/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
##ALSA Plugin
1+
# ALSA Plugin
22

33
The SOF ALSA plugin allows SOF topologies to be run on the host. The plugin
44
is still WIP with many rough edges that need refined before production
55
deployment, however the plugin is usable today as a rapid development
66
framework for SOF infrastructure and processing.
77

8-
#Features
8+
### Features
99
* aplay & arecord usage working today
1010
* alsamixer & amixer usage not working today
1111
* modules are loaded as SO shared libraries.
@@ -16,10 +16,10 @@ framework for SOF infrastructure and processing.
1616
* alsa sink and alsa source modules available.
1717
* pipelines can block (non blocking and mmap todo)
1818

19-
#License
19+
### License
2020
Code is a mixture of LGPL and BSD 3c.
2121

22-
#Usage
22+
### Usage
2323
Please build as cmake project, for IPC4 (functional)
2424
IPC3 is not functional and not supported
2525

@@ -108,10 +108,10 @@ where -n is the numid of the kcontrol, -i is the IPC version and -p is the param
108108

109109
Note: Bytes controls must have tlv_read/tlv_write and tlv_callback access.
110110

111-
# Instructions for testing OpenVino noise suppression model with the SOF plugin:
111+
## Instructions for testing OpenVino noise suppression model with the SOF plugin:
112112
1. Fetch the model from the Open Model zoo repository ex: noise-suppression-poconetlike-0001.xml
113113

114-
https://docs.openvino.ai/archive/2023.0/omz_demos.html#build-the-demo-applications-on-linux
114+
https://docs.openvino.ai/archive/2023.0/omz_demos.html#build-the-demo-applications-on-linux
115115

116116
2. Source OpenVino environment and get OpenCV
117117
https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit-download.html
@@ -133,7 +133,7 @@ to work with 48K capture.
133133
arecord -Dsof:plugin:1:0:7:16k2c16b -f dat -r 16000 --period-size=2048 file_ns_16k.wa
134134
```
135135

136-
#TODO Items (and T-shirt size) for single pipeline E2E audio
136+
### TODO Items (and T-shirt size) for single pipeline E2E audio
137137
* IPC4 support in tplg parser (M)
138138
* IPC4 support in plugin (pipe/ipc4.c) (M)
139139
* Fix ALSA -Dhw: device support (S), currently only default ALSA device works

0 commit comments

Comments
 (0)