Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
BoscoDomingo committed Jul 30, 2024
1 parent 79cd7aa commit 08d7d33
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
# SpotifyMatcher
# SpotifyMatcher <!-- omit in toc -->

![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._
Expand All @@ -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 `<MyEnv>` 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 `<MyEnv>` for your desired folder name):

```shell
python -m pip install --upgrade pip
Expand Down

0 comments on commit 08d7d33

Please sign in to comment.