summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorrealtradam <[email protected]>2020-04-26 01:24:30 -0400
committerGitHub <[email protected]>2020-04-26 01:24:30 -0400
commitc155f70cf3bdad39b4b6788f455cb5ead992d81f (patch)
treeacdb11577fd5e3d653c7f8b7c8de1f9df1df7d71 /README.md
parent46b93930c85879d700a076496d3800f7398c4cb4 (diff)
downloadmusicSorter-c155f70cf3bdad39b4b6788f455cb5ead992d81f.tar.gz
musicSorter-c155f70cf3bdad39b4b6788f455cb5ead992d81f.zip
Updated with new script functionality
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index e0afe27..1e1b185 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,12 @@
# Music Sorter
musicSorter.rb is a music sorting script I made :D Feel free to use this code as you will, I would appreciate being credited if you do.
-Will sort your music nicely into folders, using the metadata found within the song files
+## How to use it?
+Will sort your music nicely into folders, using the metadata found within the song files. Just run the script in the directory where all your unsorted songs reside, and give the script the location where you would like your sorted songs to end up in as the argument
+
+e.g:
+`ruby musicSorter.rb /home/tradam/myMusic/`
+
+## Dependencies
Requires the ffruby gem to be installed, which in turn requires libavformat and libavcodec libraries to be installed on your system