Skip to content

Commit

Permalink
docs: moved the documentation to root
Browse files Browse the repository at this point in the history
  • Loading branch information
V1p3rOne committed Oct 20, 2024
1 parent 4c8590d commit 0861110
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 34 deletions.
6 changes: 3 additions & 3 deletions docs/contributing.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<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">
<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>
Expand Down
33 changes: 33 additions & 0 deletions CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<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>

# Thanks and Acknowledgements

We would like to thank all the contributors who have helped improve this repository. We truly appreciate your time, dedication, and commitment to helping us improve and grow.

## Contributors

- **Justin025** [@justin025](https://github.com/justin025/)
- **V1p3rOne** [@V1p3rOne](https://github.com/V1p3rOne)
- **Medmondson** [@medmondson-spot](https://github.com/medmondson-spot)

## Tools Used

- [Python](https://www.python.org/)
- [Qt for Python (PyQt/PySide)](https://riverbankcomputing.com/software/pyqt/intro)**
- [PyInstaller](https://www.pyinstaller.org/)
- [FFmpeg](https://ffmpeg.org/)
- [Spotify Developers API](https://developer.spotify.com/)
- [GitHub Actions](https://github.com/features/actions)
- [Linux AppImage](https://appimage.org/)
- [MacOS DMG Creation Tools](https://apple.com)
- [Windows Build Tools](https://learn.microsoft.com/en-us/windows/win32/debug/building-on-the-command-line)

## Our Community

Lastly, a big thanks to all our users and community members who have provided feedback, reported bugs, or shared their suggestions for improvement. Your insights and support keep this project moving forward!
6 changes: 3 additions & 3 deletions docs/disclaimer.md → DISCLAIMER.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<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">
<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>
Expand Down
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,9 @@
</picture>
</div>

<br>

[![Issues Badge][issues-shield]][issues-url]
[![Stars Badge][stars-shield]][stars-url]
[![Downloads Badge][downloads-shield]][downloads-url]
[![Commits Badge][commits-shield]][commits-url]
[![License Badge][license-shield]][license-url]

<p>
Expand All @@ -38,9 +35,9 @@ OnTheSpot is a open-source user-friendly music downloader built with Qt and Pyth

### 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.
- [**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.
Expand Down Expand Up @@ -91,17 +88,14 @@ For full details, please read our [**Disclaimer**](docs/disclaimer.md).
If you have any questions, concerns, or need assistance feel free to [contact us](mailto:[email protected]).

<!-- Issues Badge -->
[issues-shield]: https://img.shields.io/github/issues/justin025/onthespot?style=flat&label=Issues&labelColor=003366&color=1DB954
[issues-shield]: https://img.shields.io/github/issues/justin025/onthespot?style=flat&label=Issues&labelColor=001224&color=1DB954
[issues-url]: https://github.com/justin025/onthespot/issues
<!-- Stars Badge -->
[stars-shield]: https://img.shields.io/github/stars/justin025/onthespot?style=flat&label=Stars&labelColor=003366&color=1DB954
[stars-shield]: https://img.shields.io/github/stars/justin025/onthespot?style=flat&label=Stars&labelColor=001224&color=1DB954
[stars-url]: https://github.com/justin025/onthespot/stargazers
<!-- Downloads Badge -->
[downloads-shield]: https://img.shields.io/github/downloads/justin025/onthespot/total.svg?style=flat&label=Downloads&labelColor=003366&color=1DB954
[downloads-shield]: https://img.shields.io/github/downloads/justin025/onthespot/total.svg?style=flat&label=Downloads&labelColor=001224&color=1DB954
[downloads-url]: https://github.com/justin025/onthespot/releases/
<!-- Commits Badge -->
[commits-shield]: https://img.shields.io/github/commit-activity/m/justin025/onthespot?style=flat&label=Commits&labelColor=003366&color=1DB954
[commits-url]: https://github.com/justin025/onthespot/commits/main
<!-- License Badge -->
[license-shield]: https://img.shields.io/github/license/justin025/onthespot?style=flat&label=License&labelColor=003366&color=1DB954
[license-shield]: https://img.shields.io/github/license/justin025/onthespot?style=flat&label=License&labelColor=001224&color=1DB954
[license-url]: https://github.com/justin025/onthespot/blob/main/LICENSE
Binary file modified assets/01_Logo/Cover_Black.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/01_Logo/Cover_White.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 0 additions & 15 deletions docs/credits.md

This file was deleted.

0 comments on commit 0861110

Please sign in to comment.