summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrianna Rainey2024-04-10 17:29:29 +0000
committerGitHub2024-04-10 17:29:29 +0000
commit53590f47a3812ea563417d2e1276e57a92a8654a (patch)
treeea303434d7a64221822d18648a45ad0804267968
parent11b12d58e90bf75d1030709ba3f1f20c3d37628a (diff)
update readme for Ubuntu 24.04
also remove outdated macOS instructions, which probably don't work anymore
-rw-r--r--README.md26
1 files changed, 5 insertions, 21 deletions
diff --git a/README.md b/README.md
index a699eb2..ed9f928 100644
--- a/README.md
+++ b/README.md
@@ -17,12 +17,10 @@ The program works on **Linux**, **macOS**, and **Windows**. If you encounter pro
17 17
18 18
19# Installation 19# Installation
20## Installation on Ubuntu 22.04 20## Installation on Ubuntu 24.04
21* Install dependencies: `sudo apt install ffmpeg python3-pip python3-pyqt5` 21* Install dependencies: `sudo apt install ffmpeg pipx python3-pyqt5`
22 * You may wish to install the app within an isolated Python environment so it doesn't affect other Python packages on your system. You can do this easily using [Pipx](https://pypi.org/project/pipx/): replace `python3-pip` with `pipx` in the apt command above, then use `pipx` instead of `pip` to automatially install Python apps in isolated environments. 22* Download this repo and run `pipx install .` in this directory
23* Download this repo and run `pip install .` in this directory (or use `pipx` for isolation)
24* Run the program with `avp` from terminal 23* Run the program with `avp` from terminal
25* Or try double-clicking the graphical shortcut ("run" or "execute" the file if asked)
26 24
27 25
28## Installation on Windows 26## Installation on Windows
@@ -35,22 +33,8 @@ The program works on **Linux**, **macOS**, and **Windows**. If you encounter pro
35* Open command prompt, `cd` into the repo directory, and run: `pip install .` 33* Open command prompt, `cd` into the repo directory, and run: `pip install .`
36* Now run `avp` or `python -m avp` from a command prompt window to start the app 34* Now run `avp` or `python -m avp` from a command prompt window to start the app
37 35
38 36## Installation on macOS
39## Manual installation on macOS 37* We need help writing instructions for macOS, but the program should work in theory.
40* **[Outdated]**: No one has updated these instructions for a while.
41* Install [Homebrew](http://brew.sh/)
42* Use the following commands to install the needed dependencies:
43```
44brew install python3
45brew install ffmpeg --with-fdk-aac --with-ffplay --with-freetype --with-libass --with-libquvi --with-libvorbis --with-libvpx --with-opus --with-x265
46brew install qt
47brew install sip --with-python3
48brew install pyqt --with-python3
49pip3 install --upgrade pip
50```
51* Download this repository and install it using Pip: `pip3 install .` (or use `pipx` for isolation)
52* Start the app with `avp` or `python3 -m avp`
53
54 38
55# [Keyboard Shortcuts](https://github.com/djfun/audio-visualizer-python/wiki/Keyboard-Shortcuts) 39# [Keyboard Shortcuts](https://github.com/djfun/audio-visualizer-python/wiki/Keyboard-Shortcuts)
56| Key Combo | Effect | 40| Key Combo | Effect |