aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIngenium232026-02-08 10:13:46 -0500
committerGitHub2026-02-08 10:13:46 -0500
commit48a9105eab94e64101470402427564203e1d8970 (patch)
tree9aa4eaf2ff3c65966589ccb1ba7dfd3ef66256e2 /README.md
parentb283aa418a1c0016a63a328fec6259dfe110cefe (diff)
docs: add macOS installation instructions (#95)
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 44 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3b5f0a2..8efdf5d 100644
--- a/README.md
+++ b/README.md
@@ -60,7 +60,50 @@ The program works on **Linux**, **macOS**, and **Windows**. If you encounter pro
## Installation on macOS
-- We need help writing instructions for macOS, but the program should work in theory.
+- Install Homebrew
+
+ - If you don't have it already, install Homebrew (the macOS package manager) by running this in your terminal:
+
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+- Install System Dependencies
+
+ - Update your packages and install FFmpeg:
+
+```bash
+brew update && brew upgrade
+brew install ffmpeg
+```
+
+- Install Python 3
+
+ - You can use a standard Python installation or Miniconda. To install Python via Homebrew:
+
+```bash
+brew install python
+```
+
+- Install and Run
+
+ - Install the latest stable version of audio-visualizer-python using pip:
+
+```bash
+pip3 install audio-visualizer-python
+```
+
+- Now run the program from your terminal:
+
+```bash
+avp
+```
+
+or
+
+```bash
+python3 -m avp
+```
## [Keyboard Shortcuts](https://github.com/djfun/audio-visualizer-python/wiki/Keyboard-Shortcuts)