Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README.md

  • Loading branch information...
commit 2abaa0cecd930b2b52592fca42a0e9d10671d47e 1 parent 677a903
Larpon authored
Showing with 16 additions and 2 deletions.
  1. +16 −2 README.md
18 README.md
View
@@ -1,6 +1,20 @@
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
Please sign in to comment.
Something went wrong with that request. Please try again.