aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e8ae7d1d95d190df374ae6ebd750341ee4fec7bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# mds - Music Directory Transformer

Transforms an Album directory into an Artist -> Album structure
based on the metadata of the files in the directory.

## Example

```shell
$ mds 'Jaco Pastorius - Jaco Pastorius (2010) [FLAC]'
$ tree "Jaco Pastorius"/
Jaco Pastorius/
└── Jaco Pastorius (2010)
    ├── 01 Donna Lee.flac
    ├── ... more flac files
    ├── dir.orig.name.txt
    └── Jaco Pastorius - Jaco Pastorius (2010).cue
$ mds "Jaco Pastorius - Invitation (1983) [FLAC]"
$ mds "Jaco Pastorius - Word Of Mouth (1981) [FLAC]"
$ tree "Jaco Pastorius"/
Jaco Pastorius/
└── Jaco Pastorius (2010)
│   ├── 01 Donna Lee.flac
│   ├── ... more flac files
│   ├── dir.orig.name.txt
│   └── Jaco Pastorius - Jaco Pastorius (2010).cue
├── Invitation (1983)
│    ├── ... more flac files
│    ├── dir.orig.name.txt
│    └── Jaco Pastorius - Invitation (1983).cue
└── Word Of Mouth (1981)
      ├── ... more flac files
      ├── dir.orig.name.txt
      └── Jaco Pastorius - Word of Mouth (1981).cue
```

Music Directory Transformer keeps a file `dir.orig.name.txt`
inside the new transformed Album directory. This way Music Directory Transformer
can transform back the directory to its original directory.

```shell
$ mds --revert "Jaco Pastorius/Jaco Pastorius (2010)"/
$ tree "Jaco Pastorius"/
Jaco Pastorius/
└── Jaco Pastorius - Jaco Pastorius (2010) [FLAC]
    ├── 01 Donna Lee.flac
    ├── ... more flac files
    ├── dir.orig.name.txt
    └── Jaco Pastorius - Jaco Pastorius (2010).cue
```

## Caveats
`mds` **does not rename or move the original directory** in both normal and reverse operation.
`mds` will not touch the files in the original directory, it will only read its metadata.