README.txt

   1 Ordnung 0.1
   2 ===========
   3
   4 Ordnung is a tool to automatically sort, organize and rename your music
   5 collection based on their tags like album, artist or title.
   6
   7 Usage
   8 -----
   9 Right now, Ordnung can only be controlled via the command line. Basic
  10 usage is:
  11
  12  ordnung.py <directory> <pattern>
  13
  14 where <directory> is where your collection is stored right now.
  15 <pattern> is any path, which contains zero or more field references
  16 which are enclosed by percent marks. If, for example, you want to sort
  17 all your music located directly in C:\Music (not in any subfolders) by
  18 Artist, then Album and have the title as name, you'd use
  19
  20  ordnung.py "C:\Music" "C:\Music\%artist%\%album%\%title%"
  21
  22 to preview, and, if the displayed result is what you want,
  23
  24  ordnung.py -m "C:\Music" "C:\Music\%artist%\%album%\%title%"
  25
  26 to actually move and rename the files. Note that the file extension must
  27 not be added manually to the pattern.
  28
  29 See ordnung.py --help for more options.
  30
  31 Valid field references
  32 ----------------------
  33 These field references are currently supported:
  34
  35 %title%     %artist%    %album artist%    %album%
  36 %composer%  %genre%     %date%
  37
  38 If %album artist% would be empty otherwise, %artist% is used in its
  39 place.
  40
  41 Dependencies
  42 ------------
  43 Ordnung has been created using Python 2.6. The following 3rd party
  44 modules must be installed as well:
  45
  46     Mutagen     <http://code.google.com/p/mutagen/>
  47     My patched version of Scott Paul Robertson's tag_wrapper
  48         <http://git.scottr.org/tag_wrapper.git/>. If you use git it's
  49         included as a submodule, else you can download it at
  50         <http://github.com/ehahn/tag_wrapper/tree/master>