People will figure out they have to add the .py extension
[ordnung.git] / README.txt
blob107a8aa58fd99eb510befb3679ad99170aeb26d1
1 Ordnung 0.1
2 ===========
4 Ordnung is a tool to automatically sort, organize and rename your music
5 collection based on their tags like album, artist or title.
7 Copyright 2009, Erik Hahn <erik_hahn@gmx.de>
9 Project Homepage: https://sourceforge.net/projects/ordnung/
11 Usage
12 -----
13 Right now, Ordnung can only be controlled via the command line. Basic
14 usage is:
16  ordnung <directory> <pattern>
18 where <directory> is where your collection is stored right now.
19 <pattern> is any path, which contains zero or more field references
20 which are enclosed by percent marks. If, for example, you want to sort
21 all your music located directly in C:\Music (not in any subfolders) by
22 Artist, then Album and have the title as name, you'd use
24  ordnung "C:\Music" "C:\Music\%artist%\%album%\%title%"
26 to preview, and, if the displayed result is what you want,
28  ordnung -m "C:\Music" "C:\Music\%artist%\%album%\%title%"
30 to actually move and rename the files. Note that the file extension must
31 not be added manually to the pattern.
33 See ordnung --help for more options.
35 Valid field references
36 ----------------------
37 These field references are currently supported:
39 %title%     %artist%    %album artist%    %album%
40 %composer%  %genre%     %date%
42 If %album artist% would be empty otherwise, %artist% is used in its
43 place.
45 Dependencies
46 ------------
47 Ordnung has been created using Python 2.6. The following 3rd party
48 modules must be installed as well:
50     Mutagen
51         <http://code.google.com/p/mutagen/>
52     Scott Paul Robertson's tag_wrapper 
53         <http://git.scottr.org/tag_wrapper.git/>.