Skip to content

Commit 2029f82

Browse files
committed
docs: Remove system-specific paths and add cross-platform instructions
- Replace /Users/tgunn absolute path with generic path/to/Parakeet-TDT - Add Windows-specific port troubleshooting commands - Make documentation agnostic to user's system - Now works equally well on Windows, macOS, and Linux
1 parent 526ed1d commit 2029f82

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

GETTING_STARTED.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@ A full-stack audio transcription application with:
1818

1919
### Step 1: Open Terminal
2020

21-
Navigate to your project:
21+
Navigate to your project directory:
2222
```bash
23-
cd /Users/tgunn/PycharmProjects/"Parakeet TDT"
23+
cd path/to/Parakeet-TDT
2424
```
2525

26+
(Replace `path/to/Parakeet-TDT` with wherever you cloned the repository)
27+
2628
### Step 2: Run Everything
2729

2830
**On macOS/Linux:**
@@ -136,6 +138,7 @@ chmod +x start.sh
136138

137139
### Port 8000 already in use
138140

141+
**On macOS/Linux:**
139142
```bash
140143
# Check what's using it
141144
lsof -i :8000
@@ -147,6 +150,18 @@ kill -9 <PID>
147150
uvicorn main:app --port 8001
148151
```
149152

153+
**On Windows:**
154+
```bash
155+
# Find what's using port 8000
156+
netstat -ano | findstr :8000
157+
158+
# Kill the process (replace PID with the number from above)
159+
taskkill /PID <PID> /F
160+
161+
# Or use a different port
162+
uvicorn main:app --port 8001
163+
```
164+
150165
### "Unable to access microphone"
151166

152167
1. Allow microphone permission in browser popup

0 commit comments

Comments
 (0)