Merge branch 'master' of github.com:kallaballa/sndcut

README.md

@@ -1,7 +1,48 @@
 sndcut is a program the generates LP records from audio files - it generates an SVG file that you can laser cut.
 it's implementation is inspired by https://github.com/mitsuhito/CuttingRecordGenerator
 
-See sndcut -h for usage.
+#Usage
 
-You can find linux packages here: http://software.opensuse.org/download.html?project=home%3Aelchaschab&package=sndcut
-
+Using sndcut is very simple. to generate a record you simply have to invoke it with an audio file (usually a wav file since mp3 is not supported. have a look [here](http://www.mega-nerd.com/libsndfile/#Features) for supported file types.
+
+The following examples will give you and idea of the basic usage. But you should be aware that you can tweak following parameters:
+
+- The diameter of the record in mm
+- The sampling rate in Hz of the resulting record. Automatic resampling will be done if it differs from the input file sampling rate. Setting this parameter to zero will adopt the sampling rate of the input file
+- Target RPM of the record
+- The maximum amplitude in mm
+- The space in between lines in mm
+- The inner margin of the record in mm
+- The outer margin of the record in mm
+- The center hole diameter in mm
+- The stroke width in the svg file in mm
+- The DPI of the laser cutter
+
+See sndcut -h for advanced usage.
+
+#Examples
+In this repository included are two pregenerated examples. They both were generated from the same wav file (imperial.wav). Please note that sndcut does automatic resampling of the audio data (default: 8000hz)
+
+Command line used to generated imperial_short.svg: 
+
+    sndcut imperial.wav > imperial_short.svg
+
+Command line used to generated imperial_long.svg:
+
+    # a diameter of 300 millimeters
+    sndcut -d300 imperial.wav > imperial_long.svg
+
+The material i used is 5mm acrylic. I used a Epilog Legend 36Ext (60W) with following settings:
+- Green lines - Speed: 12%, Power: 100%
+- Blue lines - Speed: 10%, Power: 3%
+
+If you happen to own a Epilog Legend 36Ext laser cutter you can use the ".cut" files included in the examples folder. Those files have all settings done and are ready to laser with [Ctrl-Cut](http://github.com/Metalab/ctrl-cut)
+
+#Packages
+There are linux packages available for following distributions: 
+- Fedora 20
+- OpenSUSE (13.1, 13.2, Factory)
+- Debian 7.0 
+- Ubuntu (14.04, 14.10)
+
+[Download](http://software.opensuse.org/download.html?project=home%3Aelchaschab&package=sndcut)