Update Readme.md, Readme

README

@@ -1,9 +1,12 @@
-audio2ascii
+audio2ascii:
 ===========
 
-Convert an audio file to an ascii file readable by the Natron/Nuke curve editor.
+Convert an audio file to an ascii file readable by the Natron/Nuke curve editor (Linux only).
+A Qt version (Linux + Windows) are currently being developed by @olear at:
+https://github.com/olear/audio2ascii
 
-Requirements
+
+Requirements:
 ============
 
 -   Sox: sudo apt-get install sox or sudo yum install sox.
@@ -14,11 +17,21 @@ Requirements
 
 -   Yad: If you want a gui: sudo apt-get install yad ; sudo yum install yad
 
-Installation / Usage
+Installation / Usage:
 ====================
-
-    $ wget https://github.com/rcspam/audio2ascii/releases/download/v1.2/audio2ascii
-    $ chmod +x ./audio2ascii
-    $ ./audio2ascii --help # launch command line to know the parameters
-    $ ./audio2ascii -g # or launch with gui (see Requirements above)
-
+    $ wget https://github.com/rcspam/audio2ascii/archive/v1.3.tar.gz
+    $ tar xvzf audio2ascii-1.3.tar.gz
+    $ cd audio2ascii-1.3
+    $ cp ./audio2ascii.sh /somewhere/in/your/path  # must be in your $PATH
+
+  to install the plugin: AudioToAscii.py:
+    $ # create the local Plugins directory if it doesn't exist
+    $ mkdir $HOME/.local/share/INRIA/Natron/Plugins
+    $ cp ./AudioToAscii.*  $HOME/.local/share/INRIA/Natron/Plugins
+
+If you want just add a menu command to the application’s menu-bar,
+add the following lines in your $HOME/.local/share/INRIA/Natron/Plugins/init.py
+(create init.py if doesn't exist):
+  def audioToAscii():
+      os.system("audio2ascii.sh -g &")
+  natron.addMenuCommand("Ext-Tools/AudioToAscii","audioToAscii",QtCore.Qt.Key.Key_L,QtCore.Qt.KeyboardModifier.ShiftModifier)

README.md

@@ -1,25 +1,41 @@
 # audio2ascii
 
- Convert an audio file to an ascii file readable by the Natron/Nuke curve editor.
-
+ Convert an audio file to an ascii file readable by the Natron/Nuke curve editor. (Linux only)
+ A Qt version (Linux + Windows) are currently being developed by @olear at https://github.com/olear/audio2ascii
+
 #Requirements
 
  * [Sox](http://sox.sourceforge.net/): **sudo apt-get install sox** or  **sudo yum install sox**.
- 
+
     For support more audio formats than 'wav': **sudo apt-get install libsox-fmt-all** (debian).
-		 
+
     Fedora: for mp3 support for sox you can read [this](https://unix.stackexchange.com/questions/98524/sox-returns-an-error-when-i-try-to-handle-mp3-files)
- 
+
  * [Yad](http://sourceforge.net/projects/yad-dialog): If you want a gui: **sudo apt-get install yad** ; **sudo yum install yad**
 
 #Installation / Usage
 
 ```
-$ wget https://github.com/rcspam/audio2ascii/releases/download/v1.2/audio2ascii
-$ chmod +x ./audio2ascii
-$ ./audio2ascii --help # launch command line to know the parameters
-$ ./audio2ascii -g # or launch with gui (see Requirements above)
+$ wget https://github.com/rcspam/audio2ascii/archive/v1.3.tar.gz
+$ tar xvzf audio2ascii-1.3.tar.gz
+$ cd audio2ascii-1.3
+$ cp ./audio2ascii.sh /somewhere/in/your/path  # must be in your $PATH
+```
+to install the plugin: AudioToAscii.py:
+```
+$ # create the local Plugins directory if it doesn't exist
+$ mkdir $HOME/.local/share/INRIA/Natron/Plugins
+$ cp ./AudioToAscii.*  $HOME/.local/share/INRIA/Natron/Plugins
+```
+If you want just add a menu command to the application’s menu-bar, add the following lines in your $HOME/.local/share/INRIA/Natron/Plugins/init.py (create init.py if doesn't exist):
+
+```
+import os
+def audioToAscii():
+    os.system("audio2ascii.sh -g &")
+natron.addMenuCommand("Ext-Tools/AudioToAscii","audioToAscii",QtCore.Qt.Key.Key_L,QtCore.Qt.KeyboardModifier.ShiftModifier)
 ```
+
 #Examples
 
 Some short videos released with the [Natron 2 Snapshot](http://sourceforge.net/projects/natron/files/snapshots/) Transform Node: