From 23ef9dc170a328eaa8eb4a3674c6ef60c046a38d Mon Sep 17 00:00:00 2001
From: Jali <jali@orca-central.de>
Date: Sun, 20 Mar 2022 15:56:09 +0100
Subject: [PATCH] Add initial readme text

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/README.md b/README.md
index e69de29..c0e2f30 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,35 @@
+# iTunesScraper
+
+> Version: 1.0.22079 \
+>  Created By: Jali <jali@orca0central.de> \
+>  Last Modified: Jali <jali@orca-central.de \
+
+## About
+
+The iTunes-Scraper is a small script to port and clean-up an itunes-library, when porting it to
+another music player.
+
+The trouble with iTunes is, that all meta-data is stored in a database, which is not accessible to
+anyone but iTunes itself. The stored mp3 files are not tagged, unless they are already tagged by
+beforehand. iTunes can read these tags, but it does not add to them, when the metadata is edited.
+
+In the current case, this leads to an iTunes database of mostly untagged files, which are wildly
+spread accross the users hard drive. To automatically clean up this mess, the file will do the
+following:
+
+- read am XML-dump of the iTunes library.
+- locate the files on the hard drive and copy them into a target folder.
+- read all the metadata from the iTunes library, and add id3-tags with the stored information to
+  the copied files.
+- If the file is in wav or aiff format, which doesn't allow for tagging, convert it into flac.
+
+This process is repeated for all files. If the file is not found on the hard drive, an entry in the
+logfile is found.
+
+## Dependencies
+
+The solution will be a python script, and it will rely on several python libraries, that are
+available from pip. Most of these libraries are fairly standard, such as id3-tagging or XML
+parsing. They must be present on the target system to be used. This can be done by creating a
+[venv](https://docs.python.org/3/library/venv.html) for python3.
+