Skip to content

Commit 96321b1

Browse files
committed
Updated README with Python 3.10 instructions
1 parent e92533c commit 96321b1

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
![vaporiser](assets/logo.svg)
22
![GitHub repo size](https://img.shields.io/github/repo-size/rnnh/vaporiser)
3-
![GitHub](https://img.shields.io/github/license/rnnh/vaporiser)
3+
![GitHub licence](https://img.shields.io/github/license/rnnh/vaporiser)
4+
![Code style: Black](https://img.shields.io/badge/code%20style-black-black)
5+
6+
<a href='https://ko-fi.com/rnn_h' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />
47

58
[vaporiser](https://github.com/rnnh/vaporiser) is a Python script that creates a vaporwave (slowed, with reverb) remix of a given MP3 file, with the option of playing over a looped GIF as a video.
69
It adds reverb, applies a low-pass filter, slows down, and pitches down an input MP3 file.
@@ -18,7 +21,7 @@ See [usage](#usage) for a full list of available effects.
1821

1922
## Required software
2023

21-
- [Python](https://www.python.org/) 3.6.9 or higher
24+
- [Python](https://www.python.org/) 3.10 or higher
2225
- Python modules in [requirements.txt](requirements.txt)
2326
- [Sound eXchange (SoX)](http://sox.sourceforge.net/)
2427
- [libsox-fmt-mp3 for SoX MP3 support](https://pkgs.org/download/libsox-fmt-mp3)
@@ -41,6 +44,13 @@ $ sudo apt install sox
4144
$ sudo apt-get install libsox-fmt-mp3
4245
```
4346

47+
## Installing Python 3.10 and venv on Ubuntu
48+
49+
```bash
50+
$ sudo apt install python3.10
51+
$ sudo apt-get install python3.10-venv
52+
```
53+
4454
# Setup instructions
4555

4656
## Clone the repo
@@ -53,13 +63,14 @@ $ cd vaporiser/
5363
## Create a virtual environment
5464

5565
```bash
56-
/vaporiser$ virtualenv env
66+
/vaporiser$ python3.10 -m venv env
5767
/vaporiser$ source env/bin/activate
5868
```
5969

6070
## Install required packages
6171

6272
```bash
73+
(env) /vaporiser$ pip install --upgrade pip
6374
(env) /vaporiser$ pip install -r requirements.txt
6475
```
6576

@@ -90,7 +101,7 @@ usage: vaporiser.py [-h] [-o OUTPUT_NAME] -a AUDIO_INPUT [-s SPEED_RATIO]
90101
Creates a vaporwave (slowed, with reverb) remix of a given MP3 file, with the
91102
option of playing over a looped GIF as a video.
92103
93-
optional arguments:
104+
options:
94105
-h, --help show this help message and exit
95106
-o OUTPUT_NAME, --output OUTPUT_NAME
96107
Name of output file(s), instead of audio file name

0 commit comments

Comments
 (0)