Update README.md

README.md

@@ -1,3 +1,4 @@
+
 ---
 title: Pavi
 emoji: 📊
@@ -9,4 +10,37 @@ app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Pavi 📊
+
+This is a Streamlit app that provides analytics and data visualization features. To ensure the app works correctly, especially when using audio-related libraries like `sounddevice`, some system dependencies need to be installed on Hugging Face Spaces.
+
+## How Dependencies Are Managed on Hugging Face Spaces
+
+1. **Python Dependencies**: Use a `requirements.txt` file to list all Python packages required for the app.
+
+    For example, the `requirements.txt` should include:
+
+    ```txt
+    streamlit==1.41.1
+    sounddevice
+    ```
+
+2. **System Dependencies**: Hugging Face Spaces allows the use of an `apt.txt` file to install system-level packages. To ensure PortAudio and other necessary libraries are installed, add them to `apt.txt`.
+
+    Example `apt.txt` content:
+
+    ```txt
+    portaudio19-dev
+    libasound-dev
+    libportaudio2
+    libportaudiocpp0
+    ```
+
+## How to Run the App
+
+Once the dependencies are set up, Hugging Face Spaces will automatically install everything when deploying the app. You can run the app locally or view it on the deployed Hugging Face Spaces URL.
+
+To run the app locally:
+
+```bash
+streamlit run app.py