Skip to content

Speakr is a personal, self-hosted web application designed for transcribing audio recordings

Python

readme

Murtaza Nasir2ca197ce75ff
diff --git a/readme.md b/readme.md
index a6981655..9c334fd0 100644
--- a/readme.md
+++ b/readme.md
@@ -58,7 +58,9 @@ Speakr is a personal, self-hosted web application designed for transcribing audi
## Setup Instructions
-Choose either **Docker**, **Local Development**, or **Deployment**.
+**IMPORTANT NOTE:** Currently, only the Docker installation method is working. The Local Development and Deployment methods are not functional at this time.
+
+Choose either **Docker** (recommended and currently the only working method), **Local Development**, or **Deployment**.
### 1. Docker Installation
@@ -163,6 +165,8 @@ Your data will be preserved as it's stored in Docker volumes or your custom mapp
### 2. Local Development
+**NOTE: This method is currently not working. Please use the Docker installation method above.**
+
Follow these steps to run Speakr on your local machine for development or testing.
1. **Clone the Repository:**
@@ -239,6 +243,8 @@ Follow these steps to run Speakr on your local machine for development or testin
### 3. Deployment (Linux with Systemd)
+**NOTE: This method is currently not working. Please use the Docker installation method above.**
+
The `deployment/setup.sh` script automates the setup process on a Linux server using `systemd`.
**Warning:** Review the script carefully before running it, especially the paths and user (`$USER`) it assumes.