From 816e72a38e1d4b0123f32d8e10f16c3573d97d56 Mon Sep 17 00:00:00 2001
From: Mddct <hamddct@gmail.com>
Date: Wed, 17 Jan 2024 10:15:33 +0800
Subject: [PATCH] sox in readme

---
 README.md | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6aa47a6037..cff183aa6e 100644
--- a/README.md
+++ b/README.md
@@ -58,8 +58,21 @@ git clone https://github.com/wenet-e2e/wenet.git
 ``` sh
 conda create -n wenet python=3.8
 conda activate wenet
+conda install conda-forge::sox
 pip install -r requirements.txt
 pre-commit install  # for clean and tidy code
+
+# If you encounter sox compatibility issues
+RuntimeError: set_buffer_size requires sox extension which is not available. Please refer to the stacktrace above for how to resolve this
+# Solution
+# ubuntu
+sudo apt-get install sox libsox-dev
+# centos
+sudo yum install sox sox-devel
+# conda env
+conda install  conda-forge::sox
+# MacOS
+brew install sox
 ```
 
 **Build for deployment**
@@ -100,8 +113,8 @@ Please scan the personal QR code on the right, and the guy is responsible for in
 
 ``` bibtex
 @inproceedings{yao2021wenet,
-  title={WeNet: Production oriented Streaming and Non-streaming End-to-End Speech Recognition Toolkit},
-  author={Yao, Zhuoyuan and Wu, Di and Wang, Xiong and Zhang, Binbin and Yu, Fan and Yang, Chao and Peng, Zhendong and Chen, Xiaoyu and Xie, Lei and Lei, Xin},
+title={WeNet: Production oriented Streaming and Non-streaming End-to-End Speech Recognition Toolkit},
+author={Yao, Zhuoyuan and Wu, Di and Wang, Xiong and Zhang, Binbin and Yu, Fan and Yang, Chao and Peng, Zhendong and Chen, Xiaoyu and Xie, Lei and Lei, Xin},
   booktitle={Proc. Interspeech},
   year={2021},
   address={Brno, Czech Republic },