aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMartin Kaistra2015-03-02 23:00:14 +0100
committerMartin Kaistra2015-03-02 23:00:14 +0100
commite94d6a89ca74c0c919baf5e2ae93175d6cd9f372 (patch)
tree29a27a8ebf801e64338ad8ece5dfebed0d9ae96f /README.md
parent5e0ba19538763e77c6638175d981e4c0b38e2d1d (diff)
add readme and MIT license
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f5ca16
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+audio-visualizer-python
+=======================
+
+This is a little GUI tool which creates an audio visualization video from an input audio.
+You can also give it a background image and set a title text.
+
+So far I have only tested it under Linux (Ubuntu 14.10) but it should also work under Windows and Mac OS X. If you encounter problems
+running it or have other bug reports or features, that you wish to see implemented, please fork the project and send me a pull request and/or file an issue on this project.
+
+Dependencies
+------------
+You need Python 3, PyQt4, PIL, numpy and the program ffmpeg, which is used to read the audio and render the video.
+
+Example
+-------
+You can find an example video here:
+[Youtube: A day in spring](https://www.youtube.com/watch?v=-M3jR1NuJHM)
+
+License
+-------
+audio-visualizer-python is licensed under the MIT license. \ No newline at end of file