From 0e98f1da5576d7f7bac95984d0854d651351f547 Mon Sep 17 00:00:00 2001 From: Sir RaptaG <77157639+RaptaG@users.noreply.github.com> Date: Wed, 17 May 2023 06:35:56 +0300 Subject: [PATCH] docs: Rewrite README (#511) * Initial README changes More to come * Woah, fancy! * Emojios and stuff * Test height * Another one * I think it's good now * More cool stuff * MORE EMOJIS!! * Rewrite table in HTML My brain hurts * Minor touches * Rewording * Some small tweaks * Discard extra install instructions --- README.md | 294 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 163 insertions(+), 131 deletions(-) diff --git a/README.md b/README.md index 14ac5697..430c7f38 100644 --- a/README.md +++ b/README.md @@ -1,135 +1,190 @@ -

Spotube Logo

+
+ Spotube Logo -

- spotube.netlify.app -

+ An open source, cross-platform Spotify client that doesn't require Premium nor uses Electron!
-

- - GitHub Workflow Status - - - GitHub release - - - License - - - Maintainer - - - Open Collective backers and sponsors - - - Discord - -

+ Visit the website + Discord Server + Support me on Patron + Buy me a Coffee -Spotube is a [Flutter](https://flutter.dev) based lightweight Spotify client. It utilizes the power of Spotify & Youtube's public APIs to create a reliable, robust & resource-light user experience. + Donate to our Open Collective -####

Desktop

+ --- -![Application Desktop Screenshot](assets/spotube-screenshot.jpg) + Spotube Desktop Spotube Mobile -####

Mobile

+
-![Application Mobile Screenshot](assets/mobile-screenshots/mobile-combined.jpg) +## πŸŒƒ Features -

- - - -

+- 🚫 No ads, thanks to the use of public & free Spotify and YT Music APIsΒΉ +- ⬇️ Downloadable tracks +- πŸ–₯️ πŸ“± Cross-platform support +- πŸͺΆ Small size & less data usage +- πŸ•΅οΈ Anonymous/guest login +- πŸ•’ Time synced lyrics +- βœ‹ No telemetry, diagnostics or user data collection +- πŸš€ Native performance +- πŸ“– Open source/libre software +- πŸ”‰ Playback control is done locally, not on the server -# Features +**ΒΉ** It is still **recommended** to support the creators by watching/liking/subscribing to the artists' YouTube channels or liking their tracks on Spotify (or purchasing a Spotify Premium subscription too). -Following are the features that currently Spotube offers: +### ❌ Unsupported features -- Open source/libre software -- Anonymous/guest login -- Cross platform support -- No telemetry, diagnostics or user data collection -- Lightweight & resource-friendly -- Native performance (Thanks to Flutter+Skia) -- Playback control is done locally instead of on the server -- Small size & less data usage -- No Spotify or YouTube ads since it uses all public & free APIs (It is still recommended to support the creators by watching/liking/subscribing to the artists' YouTube channels or liking their tracks on Spotify. Purchasing Spotify Premium is usually the best way to support their valuable creations.) -- Time synced lyrics -- Downloadable tracks +- πŸ—£οΈ **Spotify Shows & Podcasts:** Shows and Podcasts can **never be supported** because the audio tracks are _only_ available on Spotify and accessing them would require Spotify Premium. +- 🎧 **Spotify Listen Along:** [Coming soon!](https://github.com/KRTirtho/spotube/issues/8) -# Support development +## πŸ“œ ⬇️ Installation guide - -[!["Donate to out Collective"](https://opencollective.com/spotube/donate/button.png?color=blue)](https://opencollective.com/spotube) -[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/krtirtho) +New releases usually appear after 3-4 months.
+This handy table lists all methods you can use to install Spotube: -# Installation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PlatformPackage/Installation Method
Windows + + Windows Download + +
MacOS + + MacOS Download + +
Android + + APK download + +
+ + Download from F-Droid + +
Flatpak +

flatpak install com.github.KRTirtho.Spotube

+ + Download on Flathub + +
AppImage + + Download AppImage + +

Note: AppimageLauncher is required!

+
Debian/Ubuntu + + Debian/Ubuntu Download + +

Then run: sudo apt install Spotube-linux-x86_64.deb

+
Arch/Manjaro +

With pamac: sudo pamac install spotube-bin

+

With yay: yay -Sy spotube-bin

+
Fedora/OpenSuse + + Fedora/OpenSuse Download + +

For Fedora: sudo dnf install ./Spotube-linux-x86_64.rpm

+

For OpenSuse: sudo zypper in ./Spotube-linux-x86_64.rpm

+
Linux (tarball) + + Tarball Download + +
Windows - Chocolatey +

choco install spotube

+
Windows - Scoop +

scoop bucket add extras

+

scoop install spotube

+
Windows - WinGet +

winget install --id KRTirtho.Spotube

+
-I'm always releasing newer versions of binaries of the software every 2-3 months with minor changes & every 6-8 months with major changes. Grab them! +### πŸ”„ Nightly Builds -| Platform | Package/Installation Method | -| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Android | [Android Download][android-dlink]
[Android Download][fdroid-dlink] | -| Debian/Ubuntu | [Linux Debian/Ubuntu Download][deb-dlink]
Then run: `sudo apt install Spotube-linux-x86_64.deb` | -| Fedora/OpenSuse | [Linux Fedora/OpenSuse Download][rpm-dlink]
For Fedora: `sudo dnf install ./Spotube-linux-x86_64.rpm`
For OpenSuse: `sudo zypper in ./Spotube-linux-x86_64.rpm` | -| Flatpak | `flatpak install com.github.KRTirtho.Spotube`
Download on Flathub | -| Arch/Manjaro | pamac: `pamac install spotube-bin`
yay: `yay -Sy spotube-bin` | -| AppImage | [AppImage Download][appimage-dlink]
**Note**: AppImages require [appimage-launcher](https://github.com/TheAssassin/AppImageLauncher) to be installed | -| Linux (tarball) | [Tarball Download][linux-dlink] | -| Windows | [Windows Download][win32-dlink] | -| Windows (Chocolatey) | `choco install spotube` | -| Windows (Scoop) | `scoop bucket add extras`
`scoop install spotube` | -| Windows (WinGet) | `winget install --id KRTirtho.Spotube` | -| MacOS | [MacOS Download][mac-dlink] | +Grab the latest nightly builds of Spotube [from the GitHub Releases](https://github.com/KRTirtho/spotube/releases/tag/nightly). -> **Note!:** If you don't understand this download table. You can read [installation instructions][wiki-installation-instructions] from the wiki +## πŸ•³οΈ Building from source -## Nightly Builds -Get the latest nightly builds of Spotube [here](https://github.com/KRTirtho/spotube/releases/tag/nightly). +GitHub Workflow Status -# TODO: -- [ ] Windows OS Media Control & Media Keys Support -- [ ] Spotify Listen Along -- [x] Skip non-music sections from Audio Track -- [ ] Language Translations/Localization +You can compile Spotube's source code by [following these instructions](CONTRIBUTION.md#your-first-code-contribution). -# Building from source +## πŸ‘₯ The Spotube team -You can find the details [here](CONTRIBUTION.md#your-first-code-contribution). +- [Kingkor Roy Tirtho](https://github.com/KRTirtho) - The Founder, Maintainer and Lead Developer +- [Owen Connor](https://github.com/owencz1998) - The Cool Discord Moderator +- [Piotr Rogowski](https://github.com/karniv00l) - The MacOS Developer +- [RaptaG](https://github.com/RaptaG) - The GitHub Moderator and Community Manager +- [Rusty Apple](https://github.com/RustyApple) - The Mysterious Unknown Guy -# Things that do not work +## πŸ’Ό License -- Shows & Podcasts are not supported, as a premium subscription would be needed for that functionality. +Spotube is open source and licensed under the [BSD-4-Clause](/LICENSE) License. -# License +If you are concerned, feel free to [read the reason of choosing this license](https://dev.to/krtirtho/choosing-open-source-license-wisely-1m3p). -[BSD-4-Clause](/LICENSE) +
+ +

[Click to show] πŸ™ Library/Plugin/Framework Credits

+ -But why? You can learn about it [here](https://dev.to/krtirtho/choosing-open-source-license-wisely-1m3p). - -# Financial contributors -## Backers -![Backers](https://opencollective.com/spotube/backer.svg?button=false) -![Donors](https://opencollective.com/spotube/tiers/donor.svg?button=false) - -## Sponsors -

- Sponsor Spotube -

- -# Library/Plugin/Framework Credits - -1. [Flutter](https://flutter.dev/) - Flutter transforms the app development process. Build, test, and deploy beautiful mobile, web, desktop, and embedded apps from a single codebase -1. [Spotify API](https://developer.spotify.com/documentation/web-api/) - The Spotify Web API is a RESTful API that provides access to Spotify data -1. [Linux](https://www.linux.org/) - Linux is a family of open-source Unix-like operating systems based on the Linux kernel, an operating system kernel first released on September 17, 1991, by Linus Torvalds. Linux is typically packaged in a Linux distribution -1. [AUR](https://aur.archlinux.org/) - AUR stands for Arch User Repository. It is a community-driven repository for Arch-based Linux distributions users -1. [Flatpak](https://flatpak.org/) - Flatpak is a utility for software deployment and package management for Linux -1. [rentanadviser](https://www.rentanadviser.com/) - Generous Synced lyrics API provider service -1. [SponsorBlock](https://sponsor.ajay.app/) - SponsorBlock is an open-source crowdsourced browser extension and open API for skipping sponsor segments in YouTube videos. +1. [Flutter](https://flutter.dev) - Flutter transforms the app development process. Build, test, and deploy beautiful mobile, web, desktop, and embedded apps from a single codebase +1. [Spotify API](https://developer.spotify.com/documentation/web-api) - The Spotify Web API is a RESTful API that provides access to Spotify data +1. [Linux](https://www.linux.org) - Linux is a family of open-source Unix-like operating systems based on the Linux kernel, an operating system kernel first released on September 17, 1991, by Linus Torvalds. Linux is typically packaged in a Linux distribution +1. [AUR](https://aur.archlinux.org) - AUR stands for Arch User Repository. It is a community-driven repository for Arch-based Linux distributions users +1. [Flatpak](https://flatpak.org) - Flatpak is a utility for software deployment and package management for Linux +1. [rentanadviser](https://www.rentanadviser.com) - Generous Synced lyrics API provider service +1. [SponsorBlock](https://sponsor.ajay.app) - SponsorBlock is an open-source crowdsourced browser extension and open API for skipping sponsor segments in YouTube videos. 1. [Inno Setup](https://jrsoftware.org/isinfo.php) - Inno Setup is a free installer for Windows programs by Jordan Russell and Martijn Laan -1. [F-Droid](https://f-droid.org/) - F-Droid is an installable catalogue of FOSS (Free and Open Source Software) applications for the Android platform. The client makes it easy to browse, install, and keep track of updates on your device - +1. [F-Droid](https://f-droid.org) - F-Droid is an installable catalogue of FOSS (Free and Open Source Software) applications for the Android platform. The client makes it easy to browse, install, and keep track of updates on your device 1. [adwaita](https://github.com/gtk-flutter/adwaita) - Adwaita style - The default theme for GTK+ for your Flutter app. 1. [args](https://pub.dev/packages/args) - Library for defining parsers for parsing raw command-line arguments into a set of options and values using GNU and POSIX style options. 1. [async](https://pub.dev/packages/async) - Utility functions and classes related to the 'dart:async' library. @@ -170,7 +225,7 @@ But why? You can learn about it [here](https://dev.to/krtirtho/choosing-open-sou 1. [marquee](https://pub.dev/packages/marquee) - A Flutter widget that scrolls text infinitely. Provides many customizations including custom scroll directions, durations, curves as well as pauses after every round. 1. [metadata_god](https://github.com/KRTirtho/metadata_god) - Plugin for retrieving and writing audio tags/metadata from audio files 1. [mime](https://pub.dev/packages/mime) - Utilities for handling media (MIME) types, including determining a type from a file extension and file contents. -1. [package_info_plus](https://plus.fluttercommunity.dev/) - Flutter plugin for querying information about the application package, such as CFBundleVersion on iOS or versionCode on Android. +1. [package_info_plus](https://plus.fluttercommunity.dev) - Flutter plugin for querying information about the application package, such as CFBundleVersion on iOS or versionCode on Android. 1. [palette_generator](https://pub.dev/packages/palette_generator) - Flutter package for generating palette colors from a source image. 1. [path](https://pub.dev/packages/path) - A string-based path manipulation library. All of the path operations you know and love, with solid support for Windows, POSIX (Linux and Mac OS X), and the web. 1. [path_provider](https://pub.dev/packages/path_provider) - Flutter plugin for getting commonly used locations on host platform file systems, such as the temp and app data directories. @@ -184,7 +239,7 @@ But why? You can learn about it [here](https://dev.to/krtirtho/choosing-open-sou 1. [tuple](https://pub.dev/packages/tuple) - A library providing a tuple data structure. 1. [url_launcher](https://pub.dev/packages/url_launcher) - Flutter plugin for launching a URL. Supports web, phone, SMS, and email schemes. 1. [uuid](https://github.com/Daegalus/dart-uuid) - RFC4122 (v1, v4, v5) UUID Generator and Parser for all Dart platforms (Web, VM, Flutter) -1. [version](https://github.com/dartninja/version) - Provides a simple class for parsing and comparing semantic versions as defined by http://semver.org/ +1. [version](https://github.com/dartninja/version) - Provides a simple class for parsing and comparing semantic versions as defined by http://semver.org 1. [visibility_detector](https://pub.dev/packages/visibility_detector) - A widget that detects the visibility of its child and notifies a callback. 1. [window_manager](https://github.com/leanflutter/window_manager) - This plugin allows Flutter desktop apps to resizing and repositioning the window. 1. [youtube_explode_dart](https://github.com/Hexer10/youtube_explode_dart) - A port in dart of the youtube explode library. Supports several API functions without the need of Youtube API Key. @@ -197,32 +252,9 @@ But why? You can learn about it [here](https://dev.to/krtirtho/choosing-open-sou 1. [pub_api_client](https://github.com/leoafarias/pub_api_client) - An API Client for Pub to interact with public package information. 1. [pubspec_parse](https://pub.dev/packages/pubspec_parse) - Simple package for parsing pubspec.yaml files with a type-safe API and rich error reporting. 1. [catcher](https://github.com/jhomlala/catcher) - Plugin for error catching which provides multiple handlers for dealing with errors when they are not caught by the developer. -1. [platform_ui](https://github.com/KRTirtho/platform_ui) - Platform specific Widgets and UI toolkit 1. [spotify](https://github.com/rinukkusu/spotify-dart) - An incomplete dart library for interfacing with the Spotify Web API. 1. [window_size](https://github.com/google/flutter-desktop-embedding.git) - Allows resizing and repositioning the window containing Flutter. -# The team +
-- [Kingkor Roy Tirtho](https://github.com/KRTirtho) - The Founder, Maintainer and Lead Developer -- [Owen Conor](https://github.com/owencz1998) - The Cool Discord Moderator -- [Piotr Rogowski](https://github.com/karniv00l) - The MacOS Developer -- [RaptaG](https://github.com/raptag) - The GitHub Moderator and Community Manager -- [Rusty Apple](https://github.com/RustyApple) - The Mysterious Unknown Guy - -# Social platforms - -Follow me on [Twitter](https://twitter.com/@krtirtho), or join our amazing [Discord](https://discord.gg/uJ94vxB6vg) server to always get newer updates about the application. - -

© 2023 Spotube

 - - -[win32-dlink]: https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-windows-x86_64-setup.exe -[deb-dlink]: https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.deb -[rpm-dlink]: https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.rpm -[linux-dlink]: https://github.com/KRTirtho/spotube/releases/latest -[appimage-dlink]: https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.AppImage -[mac-dlink]: https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-macos-x86_64.dmg -[android-dlink]: https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-android-all-arch.apk -[fdroid-dlink]: https://f-droid.org/packages/oss.krtirtho.spotube/ - -[wiki-installation-instructions]: https://github.com/KRTirtho/spotube/wiki/Installation-Instrcutions +

Β© Copyright Spotube 2023