Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pckbls committed Jul 26, 2017
1 parent 620aed7 commit 0cef115
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,25 @@ Right now it's more or less a proof of concept with little to no features.

![Draft](images/draft_animated.gif)

# Dependencies
# Installation

A recent version of Python 3 (3.5 and above), `pyglet`, `numpy` and (of course) PulseAudio are required.
Both `pyglet` and `numpy` should be part of the official repositories for all major Linux distributions.
Alternatively they can be installed via `pip3`:
pulseviz can be installed via `pip3`:

```sh
pip3 install -r requirements.txt
# System wide...
sudo pip3 install git+https://github.com/pckbls/pulseviz.git

# ...or only for the current user
pip3 install --user git+https://github.com/pckbls/pulseviz.git
```

# How to use
# Usage

pulseviz requires you to choose from an audio source and a visualizer type:
pulseviz requires you to choose an audio source and a visualizer type:

```
$ ./pulseviz.py
Usage: ./pulseviz.py <source> <visualizer>
$ pulseviz
Usage: pulseviz <source> <visualizer>
Available sources:
alsa_output.pci-0000_00_1b.0.analog-stereo.monitor
Expand Down

0 comments on commit 0cef115

Please sign in to comment.