Updated Readme with Argparse
This commit is contained in:
parent
29df89f0d4
commit
9a58a5901f
19
README.md
19
README.md
|
@ -1,6 +1,20 @@
|
||||||
# vaporwave generator 旺育栄
|
# vaporwave generator 旺育栄
|
||||||
A vaporwave music (+art, +video soon, I promise) generator bodged together using code from various sources. Runs on Python3
|
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]
|
||||||
|
|
||||||
|
This program takes YouTube URL or title of a song and converts it into
|
||||||
|
vaporwave
|
||||||
|
|
||||||
|
optional arguments:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
-M, --music generate v a p o r w a v e music
|
||||||
|
-V, --version show program version
|
||||||
|
-i INPUT, --input INPUT
|
||||||
|
input url
|
||||||
|
```
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
This was tested on macOS Catalina ( so should work on almost all macOS versions).
|
This was tested on macOS Catalina ( so should work on almost all macOS versions).
|
||||||
|
@ -28,11 +42,11 @@ pip install -r requirements.txt
|
||||||
|
|
||||||
### YouTube URL
|
### YouTube URL
|
||||||
```
|
```
|
||||||
python3 main.py <YOUTUBE_URL>
|
python3 main.py -M -i <YOUTUBE_URL>
|
||||||
```
|
```
|
||||||
### Song Title
|
### Song Title
|
||||||
```
|
```
|
||||||
python3 main.py Song Title
|
python3 main.py -M -i Song Title
|
||||||
```
|
```
|
||||||
|
|
||||||
## Bugs
|
## Bugs
|
||||||
|
@ -49,4 +63,5 @@ This project is a result of bodging and therefore has tons of bugs which need to
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
@WJLiddy His repo `Macintech` forms the base code for the music generator
|
@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)
|
@felipecustodio Using his repo `virtualdreamsbot` YouTube DL code ( Hopefully I will be able to integrate this project as a Telegram Bot)
|
Loading…
Reference in New Issue