aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 33 insertions, 9 deletions
diff --git a/README.md b/README.md
index 5095da4..0fea756 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
# vaporwave generator 旺育栄
+
A vaporwave music (+art, +video soon, I promise) generator bodged together using code from various sources. Runs on Python3
```
-usage: main.py [-h] [-M] [-V] [-i INPUT]
+usage: main.py [-h] [-M] [-P] [-V] [-i INPUT]
This program takes YouTube URL or title of a song and converts it into
vaporwave
@@ -10,13 +11,26 @@ vaporwave
optional arguments:
-h, --help show this help message and exit
-M, --music generate v a p o r w a v e music
+ -P, --picture generate VHS Style image
-V, --version show program version
-i INPUT, --input INPUT
- input url
+
```
If the program gives an error for sox, try running `ulimit -n 999'`
+## Demo
+
+### M U S I C
+
+Linking to Bandcamp soon
+
+### V H S I M A G E
+
+![]("assets/in-vhs.jpg")
+
+![]("assets/out-vhs.jpg")
+
## Installation
This was tested on macOS Catalina ( so should work on almost all macOS versions).
@@ -43,28 +57,38 @@ pip install -r requirements.txt
## Usage
-### YouTube URL
+### M U S I C
+
+#### YouTube URL
```
python3 main.py -M -i <YOUTUBE_URL>
```
-### Song Title
+#### Song Title
```
python3 main.py -M -i Song Title
```
+### V H S I M A G E S
+
+`python3 main.py -P -i "image.jpg"`
+
## Bugs
This project is a result of bodging and therefore has tons of bugs which need to be ironed out
## To-Do
-[ ] Move away from using os.system calls, and use Python modules instead ( Looking at you, Sox and aubio)
-[ ] Clean the Code
-[ ] Add Artwork Generator
-[ ] Add Video Generator
+[] Move away from using os.system calls, and use Python modules instead ( Looking at you, Sox and aubio)
+[] Clean the Code
+[] Add Artwork Generator
+[x] VHS Picture Styler ( Added in v1.5 )
+[] Add Video Generator
+[] Add Custom Date to VHS Styler
## Credits
@WJLiddy His repo `Macintech` forms the base code for the music generator
-@felipecustodio Using his repo `virtualdreamsbot` YouTube DL code ( Hopefully I will be able to integrate this project as a Telegram Bot) \ No newline at end of file
+@felipecustodio Using his repo `virtualdreamsbot` YouTube DL code ( Hopefully I will be able to integrate this project as a Telegram Bot)
+
+@Ragex04 His repo `VHS_BingImages` forms the base code for the VHS Image Styler \ No newline at end of file