From 088a3fb2a0a77c16429d0f148ed174a22e7c4f65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Anh=20Khoa?= Date: Fri, 2 Mar 2018 23:03:06 +0700 Subject: [PATCH] Create README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0d96f90 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# musipy + +## Usage + +python musipy.py -s source/dir/ -o output/dir/ -attr attribute -m sort + +### -s, --source= + +The source directory to scan for files, default to current directory when you run this script + +### -o, --output= + +The output directory, default to source/dir/output + +### -attr, --attribute= + +The attribute to use when sort, this could either be 'genre' or 'album' + +### -m, --mode= + +The mode to use, currently only 'sort' is able to use. In future update: + ++ [X] 'sort' for sorting files in source/dir by attribute ++ [ ] 'backup' for backing up files structure in a source/dir ++ [ ] 'restore' for restoring files in source/dir to a backup flash ++ [ ] 'rename' for rename multiple files names (Track1.mp3, Track2.mp3... or similar) using a file input of Titles, Artist, Genre, Album, Disk ++ [ ] 'playlist' for creating playlist file by any config in source/dir + +## Why I create this + +I have a very big folder of files, and searching through files is hard for me, also, the structure when I first place them in is hard to navigate. I want to create a script to move files using tag and organize them. And create a playlist with the options I prefer. + +## When will I deploy? + +I don not know, I just create for myself. Hosting on Git is to keep my project organized, and hope to get some collaborators. + +## License + +I have not yet decide.