aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorneodarz <neodarz@neodarz.net>2017-10-15 18:56:30 +0200
committerneodarz <neodarz@neodarz.net>2017-10-15 18:56:30 +0200
commit876efed77ed1a80de27f91a5ab01d6bcee73bdd0 (patch)
treeaabe147ff72706133690761b654d1d4d697c5cef
parent9d4af00439c1351eb9defb62daebd4930acb5a14 (diff)
downloadconvert.py-876efed77ed1a80de27f91a5ab01d6bcee73bdd0.tar.xz
convert.py-876efed77ed1a80de27f91a5ab01d6bcee73bdd0.zip
Add a README
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4f98808
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# convert.py
+
+This tool can convert files from mp4, mkv or webw to mp3.
+
+It use ffmpeg for the conversion.
+
+# How to use
+
+## Usage
+
+```
+convert.py [-n|-y] [SOURCE] [DESTINATION]
+```
+
+## Options
+
+- `-n` <- Does't overwrite output files, and go to next file to be converted
+if the specified output file already exists. It's the default option.
+- `-y` <- Overwrite output files.
+
+## Exemple
+
+```
+./convert.py video_folder_input audio_folder_output
+```
+
+Where `video_input` is a folder who contain some video files and `audio_output`
+is the folder where the files converted are stored.
+
+# Why ?
+
+For fun and learn. And also because I use it for convert some video clip from
+youtube to mp3 files for listen on my local server and on my mobile.