From 08d7d332a815b354d594c8b31faa40f29acbfd80 Mon Sep 17 00:00:00 2001 From: Bosco Domingo Date: Tue, 30 Jul 2024 23:57:48 +0200 Subject: [PATCH] chore: update README --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 41fb664..0b381aa 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,22 @@ -# SpotifyMatcher +# SpotifyMatcher ![Logo image](https://user-images.githubusercontent.com/46006784/166269127-56d4709d-6464-4f83-aace-e6fb53bbbd9d.png) Cross-platform tool to match your local files to Spotify's database. Easily transfer all your local songs over to a playlist on Spotify in just a few minutes. Migrating your local library has never been easier! +1. [Before you start (5 minutes)](#before-you-start-5-minutes) + 1. [Install Python \>=3.10](#install-python-310) + 2. [Using poetry (OPTIONAL, RECOMMENDED)](#using-poetry-optional-recommended) + 3. [Using venv (OPTIONAL)](#using-venv-optional) + 1. [Installing the libraries](#installing-the-libraries) + 4. [Creating a Spotify Developer Application](#creating-a-spotify-developer-application) +2. [Using SpotifyMatcher](#using-spotifymatcher) + 1. [**_CAREFUL_**](#careful) +3. [Getting your username and playlist ids](#getting-your-username-and-playlist-ids) + 1. [Username](#username) + 2. [Playlist id](#playlist-id) + + ## Before you start (5 minutes) _This isn't infalible, and it would be quite surprising if it matched 100% of songs. Be aware you'll probably have to do **a bit** of manual searching, but this will significantly reduce that amount by automating the majority of the process._ @@ -18,13 +31,13 @@ You'll need to install the libraries `spotipy`, `tinytag` and `eyed3` I suggest you create a virtual environment so you don't mess other libraries, with the built-in `venv` or via `poetry`. -### Using poetry (OPTIONAL, RECOMMENDED) +### Using [poetry](https://python-poetry.org/docs/) (OPTIONAL, RECOMMENDED) Simply run `poetry install` and it'll create a venv with the correct requirements inside. If you don't have poetry, I suggest you install it globally using `pip install poetry`. ### Using venv (OPTIONAL) -For this, simply navigate to or open a Terminal in the folder that the code is in (type `wt` in the Windows Explorer address bar for Windows Terminal, or `cmd` if that doesn't work) and write the following commands (make sure to change `` for your desired folder name): +For this, simply navigate to or open a terminal in the folder that the code is in (type `wt` in the Windows Explorer address bar for Windows Terminal, or `cmd` if that doesn't work) and write the following commands (make sure to change `` for your desired folder name): ```shell python -m pip install --upgrade pip