Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Larpon committed Jan 10, 2014
1 parent 677a903 commit 2abaa0c
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Original file line Diff line number Diff line change
@@ -1,6 +1,20 @@
pyClickTrack pyClickTrack
============ ============


A little python script to generate click tracks. pyClickTrack is, as the name suggests, a python program to generate click tracks. A click track is commonly used by musicians to navigate and time the beat of any given song. Click tracks can be crucial in helping to keep the timing or *tightness* right when recording live or via a [DAW](http://en.wikipedia.org/wiki/Digital_audio_workstation "Digital Audio Workstation").

pyClickTrack uses [YAML](http://yaml.org/ "YAML.org") (an easy to read plain text configuration file format) as input and standard WAVE (.wav) files as output - if ffmpeg or libav is present on the system pyClickTrack will unlock a very large range of output formats as it relies on [pyDub](https://github.com/jiaaro/pydub) as audio processing library.

Quick start
-----------

See if stuff works:

### Linux
$ ``python pyClickTrack ./Test.ct``

### Windows (if python is in path):
C:\> ``python pyClickTrack Test.ct``

The above should create a file named *Test.wav* in the current directory.


TODO write something useful

0 comments on commit 2abaa0c

Please sign in to comment.