Improve documentation and file structure

DISCLAIMER.md

@@ -1,74 +1,16 @@
-<picture>
-  <source media="(prefers-color-scheme: dark)" srcset="assets/01_Logo/Cover_White.png">
-  <source media="(prefers-color-scheme: light)" srcset="assets/01_Logo/Cover_Black.png">
-  <img src="assets/01_Logo/Cover_White.png" alt="Logo of OnTheSpot" width="350">
-</picture>
-
-<br>
-
 # Disclaimer
 
-OnTheSpot is an open-source project **licensed under GPL-2.0** and is provided for **educational and personal use only**. Please ensure that you read and understand this disclaimer fully before using OnTheSpot!
+OnTheSpot is an open-source project licensed under GPL-2.0 and its code is distributed for educational and personal use only.
 
 By using this software, you agree to the following terms:
 
-## 1. Purpose and Use
-
-- **Educational and Personal**<br>
-  OnTheSpot is developed to enhance users' experience with their legitimate music streaming subscriptions.
-
-- **No Illegal Activity**<br>
-  The software is **not intended** to facilitate any form of illegal activity, including unauthorized downloading, copying, converting, or distribution of copyrighted material.
-
-## 2. No Affiliation
-
-- **Independent Project**<br>
-  OnTheSpot is **not affiliated with, endorsed by, or associated with** any music streaming services or platforms.
-
-- **Trademarks**
-  All trademarks and service marks remain the property of their respective owners.
-
-## 3. Legal Compliance
-
-- **User Responsibility**<br>
-  Users are solely responsible for ensuring that their use of OnTheSpot complies with all **applicable laws and regulations**, including copyright laws and intellectual property rights.
-- **Third-Party Terms**<br>
-  Users must **review and adhere to** the terms of service and user agreements of any third-party services accessed through OnTheSpot.
-- **No Circumvention**<br>
-  The software must not be used to **bypass, circumvent, or interfere** with any digital rights management systems or technological protection measures.
-
-## 4. Usage Limitations
-
-- **Prohibited Actions**
-
-  - **Unauthorized Downloading**<br>Do not use OnTheSpot to download, copy, reproduce, distribute, or store any content from third-party services without proper authorization.
-  - **Modification**<br>Do not modify, decompile, disassemble, or reverse engineer any part of the software or third-party content accessed through the software.
-  - **Commercial Use**<br>OnTheSpot is for personal use only and must not be used for commercial purposes without explicit permission.
-
-- **No Permanent Storage**<br>The software does **not support** permanent downloading or storage of media content beyond what is allowed by your subscription and applicable laws.
-
-## 5. Liability and Warranty
-
-- **Limitation of Liability**
-
-  - **No Liability for Misuse**<br>The developers and contributors assume **no liability** for any misuse of the software or its source code.
-  - **User Actions**<br>They are **not responsible** for any illegal actions performed by users, including unauthorized downloading or sharing of copyrighted content.
-  - **Indemnification**<br>Users agree to **indemnify and hold harmless** the developers and contributors from any claims or legal actions arising from their use of OnTheSpot.
-
-- **No Warranty**
-
-  - **"As Is"**<br>OnTheSpot is provided **"as is"**, without warranties of any kind, express or implied.
-  - **No Guarantees**<br>No guarantee that the software will meet your requirements or be uninterrupted, error-free, or secure.
 
-## 6. Agreement and Modifications
+-  The software is not intended to facilitate any form of illegal activity, including unauthorized downloading, copying, converting, or distribution of copyrighted material. The software must not be used to bypass, circumvent, or interfere with any digital rights management systems.
 
-- **Acceptance**
+- Users are solely responsible for ensuring that their use of OnTheSpot complies with all applicable laws in their respective juristiction.
 
-  - By using OnTheSpot, you acknowledge that you have read this disclaimer and agree to be bound by its terms.
-  - If you **do not agree**, you must **immediately cease** using the software.
+- OnTheSpot is not affiliated with, endorsed by, or associated with any music streaming platforms. All mentioned services, trademarks, and images in use by this project remain the property of their respective owners.
 
-- **Changes to Disclaimer**
+- The developers and contributors assume no liability for any misuse of the software or its source code.
 
-  - **Right to Modify**<br>We reserve the right to modify this disclaimer at any time.
-  - **Effective Upon Posting**<br>Changes are effective immediately upon posting in the repository.
-  - **Continued Use**<br>Continued use after changes indicates acceptance of the updated disclaimer.
+- OnTheSpot is provided "as is", without warranties of any kind, express or implied. The software must not be used for commercial purposes without explicit permission.

README.md

@@ -2,9 +2,7 @@
 
 <div style="text-align: center;">
   <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="assets/01_Logo/Repository-Logo.png">
-    <source media="(prefers-color-scheme: light)" srcset="assets/01_Logo/Repository-Logo.png">
-    <img src="assets/01_Logo/Repository-Logo.png" alt="Logo of OnTheSpot" width="350px">
+    <img src="assets/logos/repository_logo.png" alt="Repository Logo" width="350px">
   </picture>
 </div>
 
@@ -25,67 +23,40 @@
    <br>
 </div>
 
-<br>
+An easy to use music downloader written in Python. OnTheSpot has support for various music services and, unlike similar projects, downloaded files and metadata are sourced directly from the service of your choosing. The app includes a GUI, CLI, and Web UI frontend. To get started download the app [here](https://github.com/justin025/onthespot/releases/latest) or run the command below.
+```bash
+python -m pip install git+https://github.com/justin025/onthespot
+```
+For more further documentation, please see the following:
 
-## What is OnTheSpot?
+1. [**Installation Guide**](docs/INSTALLATION.md)
+2. [**Basic Usage Instructions**](docs/USAGE.md)
 
-OnTheSpot is an open-source user-friendly music downloader built with Qt and Python. Inspired by the original [**OnTheSpot**](https://github.com/casualsnek/onthespot) and [**Zotify**](https://github.com/zotify-dev/zotify), made for educational and personal use only. You can search for songs, artists, albums, playlists, podcasts, and audiobooks and download them straight to your device. It's designed to work across multiple platforms, so anyone can enjoy their favourite music offline.
 
-![OTS_Overview](assets/02_Images/IMG_Overview.png)
+# Screenshots
+![Search](assets/images/search.png)
+![Download Queue](assets/images/download_queue.png)
+![Settings](assets/images/settings.png)
 
-### Features
 
-- [**Cross Platform**](https://www.techopedia.com/definition/17056/cross-platform)<br>Available for Windows, MacOS, and Linux (Including AppImage, PKGBUILD, and eBuild).
-- [**High Quality Downloads**](https://www.whathifi.com/advice/high-resolution-audio-everything-you-need-to-know)<br>Download music up to 320kbps directly from the source.
-- [**Multi Language Support**](https://phrase.com/blog/posts/multilingual-customer-support/)<br>Download track and album names translated to your application's language.
-- [**Comprehensive Content Coverage**](https://thisisglance.com/blog/why-spotify-is-the-outright-best-music-streaming-app)<br>Supports songs, podcasts, playlists, albums, singles, compilations, and audiobooks.
-- [**Rich Metadata Embedding**](https://sonosuite.com/en/blog/what-is-music-metadata-and-why-is-important-to-digital-music/)<br>Automatically embed detailed metadata like artist, album, year, and lyrics.
-- [**Custom Download Paths**](https://www.microsoft.com/en-us/microsoft-365/business-insights-ideas/resources/11-ideas-for-how-to-organize-digital-files)<br>Set personalized paths for playlists and episodes for easy organization.
-- [**Free and Premium Support**](https://community.spotify.com/t5/Social-Random/What-is-the-difference-between-free-Spotify-and-Premium/td-p/5478479)<br>Compatible with both free and premium accounts.
+## Need More Help?
 
-> [!IMPORTANT]
-> If you want to know more about the features, take a look at the application itself or check out our documentation.
-
-## Getting Started
-
-OnTheSpot is an open-source music search and download application. You can find what you need by entering queries or URLs and the app will locate the relevant media for you. Downloads are easy to manage with options to adjust settings, formats, and directories to your liking.
-
-To begin, please refer to the following documents:
-
-1. [**Installation Guide**](docs/installation.md)
-2. [**Basic Usage Instructions**](docs/usage.md)
-
-### Need More Help?
-
-If you have any questions or run into issues while using OnTheSpot, feel free to ask by:
+If you have any questions or run into issues while using OnTheSpot, feel free to ask for assistance by:
 
 - [**Opening an Issue**](https://github.com/justin025/onthespot/issues)
 - [**Joining Our Discord**](https://discord.gg/GCQwRBFPk9)
 
 ## Contributing
 
-Contributions are welcome! If you encounter bugs, have suggestions, or would like to translate the app to your native language feel free to [**open an issue**](https://github.com/justin025/onthespot/issues) or submit a pull request.
-
-For more detailed info, please read our [**Contributions**](docs/contributing.md) Document.
+If you encounter bugs, have suggestions, or would like to help translate the app to your native language feel free to [**open an issue**](https://github.com/justin025/onthespot/issues) or submit a pull request.
 
 ## Disclaimer
 
-OnTheSpot is an open-source project designed to enhance your experience with legitimate music streaming subscriptions for **educational and personal use only**.
-
-### Important Notice
-
-- [**Educational and Personal Use Only**](docs/disclaimer.md#1-purpose-and-use)
-- [**Independent Project**](docs/disclaimer.md#2-no-affiliation)
-- [**Legal Compliance**](docs/disclaimer.md#3-legal-compliance)
-- [**Usage Limitations**](docs/disclaimer.md#4-usage-limitations)
-- [**Liability and Warranty**](docs/disclaimer.md#5-liability-and-warranty)
-- [**Agreement and Modifications**](docs/disclaimer.md#6-agreement-and-modifications)
-
-For full details, please read our [**Disclaimer**](docs/disclaimer.md).
+OnTheSpot is intended to be used in compliance with DMCA, Section 1201, for educational, private and fair use.
+OnTheSpot contributors are not responsible for any misuse of the program or source code.
 
-## Contact Us
 
-If you have any questions, concerns, or need assistance feel free to [contact us](mailto:[email protected]).
+For further information, please see the following [**disclaimer**](DISCLAIMER.md).
 
 <!-- Issues Badge -->
 [issues-shield]: https://img.shields.io/github/issues/justin025/onthespot?style=flat&label=Issues&labelColor=001224&color=1DB954

docs/INSTALLATION.md

@@ -0,0 +1,79 @@
+# Installation Options
+
+## 1. Install Through Prebuilt Releases (Recommended)
+
+This is the easiest way to get started.
+
+1. **Download the Latest Release**
+
+   - Visit our [GitHub Releases Page](https://github.com/justin025/onthespot/releases).
+   - Look for the latest version suitable for your operating system:
+     - **Windows Users**: Download the `.exe` file.
+     - **MacOS Users**: Download the `.dmg` file associated with your mac (x86_64 for intel, arm64 for apple silicone).
+     - **Linux Users**: Download the `.AppImage` or `tar.gz` file.
+
+2. **Install OnTheSpot**
+
+   - **Windows**: Run the downloaded `.exe`.
+   - **MacOS**: Open the `.dmg`, follow the instructions listed in README.txt, and drag `OnTheSpot.app` into your `Applications` folder.
+   - **Linux**: Make the `.AppImage` executable and run it, alternatively extract the tar.gz and execute the binary.
+
+> [!TIP]
+> For MacOS, if you encounter security warnings, right-click the app and select "Open" from the context menu to bypass the gatekeeper.
+
+3. **Launch OnTheSpot**
+
+   - Open the application from your Downloads folder or Applications menu.
+
+![OTS_Download_1](../assets/gifs/download.gif)
+
+## 2. Build The App From Source
+
+If you prefer to build OnTheSpot yourself, follow these steps.
+
+1. **Install Python and Download the Source Code**
+
+   - Installing python can vary depending on your operating system.
+   - The source code can be downloaded through github or through the commands below:
+
+     ```bash
+     git clone https://github.com/justin025/onthespot
+     cd onthespot
+     ```
+
+2. **Run the Build Script for Your Operating System**
+
+   - **Windows**: Open the `scripts` Folder. Double-click [`build_windows.bat`](scripts/build_windows.bat) or run it in Command Prompt.
+   - **MacOS**: Run [`build_mac.sh`](scripts/build_mac.sh) in Terminal with `./scripts/build_mac.sh`.
+   - **Linux**: Run [`build_linux.sh`](scripts/build_linux.sh) in Terminal with `./scripts/build_linux.sh`.
+   - **Linux AppImage**: Run [`build_appimage.sh`](scripts/build_appimage.sh) in Terminal with `./scripts/build_appimage.sh`.
+
+3. **Install and Launch OnTheSpot**
+
+   After building the application will be located in the `dist` folder. Be sure to follow installation steps based on your operating system.
+
+
+## 3. Install Via Pip or Run The App From Source
+You can install the app via pip, ensure you have ffmpeg, python, and git installed in your path. Run the commands below to setup the environment:
+```bash
+python -m venv venv
+source venv/bin/activate
+```
+Next you can download and run the app by installing via pip:
+```bash
+python -m pip install git+https://github.com/justin025/onthespot
+
+onthespot-cli #cli
+onthespot-gui #gui
+onthespot-web #web ui
+```
+Alternatively you can run the app from source following the commands listed below:
+```bash
+git clone https://github.com/justin025/onthespot
+
+cd onthespot/src
+
+python -m onthespot.cli #cli
+python -m onthespot.__init__ #gui
+python -m onthespot.web #web ui
+```