mirror of
https://github.com/librespot-org/librespot.git
synced 2024-12-18 17:11:53 +00:00
Fix typos and define what's "breaking"
This commit is contained in:
Roderick van Domburg
parent
2fcd24164d
commit
9cb98e9e21
2 changed files with 10 additions and 10 deletions
|
|
@ -31,7 +31,7 @@ In order to prepare for a PR, you will need to do a couple of things first:
|
|||
|
||||
Make any changes that you are going to make to the code, but do not commit yet.
|
||||
|
||||
Unless your changes are negligible, please add an entry in the "Unreleased" section of `CHANGELOG.md`. Refer to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) for instructions on how this entry should look like.
|
||||
Unless your changes are negligible, please add an entry in the "Unreleased" section of `CHANGELOG.md`. Refer to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) for instructions on how this entry should look like. If your changes break the API such that downstream packages that depend on librespot need to update their source to still compile, you should mark your changes as `(breaking)`.
|
||||
|
||||
Make sure that the code is correctly formatted by running:
|
||||
```bash
|
||||
|
|
|
|||
14
README.md
14
README.md
|
|
@ -7,7 +7,7 @@ Current maintainers are [listed on GitHub](https://github.com/orgs/librespot-org
|
|||
# librespot
|
||||
*librespot* is an open source client library for Spotify. It enables applications to use Spotify's service to control and play music via various backends, and to act as a Spotify Connect receiver. It is an alternative to the official and [now deprecated](https://pyspotify.mopidy.com/en/latest/#libspotify-s-deprecation) closed-source `libspotify`. Additionally, it will provide extra features which are not available in the official library.
|
||||
|
||||
_Note: librespot only works with Spotify Premium. This will remain the case. We will not any support features to make librespot compatible with free accounts, such as limited skips and adverts._
|
||||
_Note: librespot only works with Spotify Premium. This will remain the case. We will not support any features to make librespot compatible with free accounts, such as limited skips and adverts._
|
||||
|
||||
## Quick start
|
||||
We're available on [crates.io](https://crates.io/crates/librespot) as the _librespot_ package. Simply run `cargo install librespot` to install librespot on your system. Check the wiki for more info and possible [usage options](https://github.com/librespot-org/librespot/wiki/Options).
|
||||
|
|
@ -20,7 +20,7 @@ As the origin by [plietar](https://github.com/plietar/) is no longer actively ma
|
|||
# Documentation
|
||||
Documentation is currently a work in progress, contributions are welcome!
|
||||
|
||||
There is some brief documentation on how the protocol works in the [docs](https://github.com/librespot-org/librespot/tree/master/docs) folder,
|
||||
There is some brief documentation on how the protocol works in the [docs](https://github.com/librespot-org/librespot/tree/master/docs) folder.
|
||||
|
||||
[COMPILING.md](https://github.com/librespot-org/librespot/blob/master/COMPILING.md) contains detailed instructions on setting up a development environment, and compiling librespot. More general usage and compilation information is available on the [wiki](https://github.com/librespot-org/librespot/wiki).
|
||||
[CONTRIBUTING.md](https://github.com/librespot-org/librespot/blob/master/CONTRIBUTING.md) also contains our contributing guidelines.
|
||||
|
|
@ -30,10 +30,10 @@ If you wish to learn more about how librespot works overall, the best way is to
|
|||
# Issues & Discussions
|
||||
**We have recently started using Github discussions for general questions and feature requests, as they are a more natural medium for such cases, and allow for upvoting to prioritize feature development. Check them out [here](https://github.com/librespot-org/librespot/discussions). Bugs and issues with the underlying library should still be reported as issues.**
|
||||
|
||||
If you run into a bug when using librespot, please search the existing issues before opening a new one. Chances are, we've encountered it before, and have provided a resolution. If not, please open a new one, and where possible, include the backtrace librespot generates on crashing, along with anything we can use to reproduce the issue, eg. the Spotify URI of the song that caused the crash.
|
||||
If you run into a bug when using librespot, please search the existing issues before opening a new one. Chances are, we've encountered it before, and have provided a resolution. If not, please open a new one, and where possible, include the backtrace librespot generates on crashing, along with anything we can use to reproduce the issue, e.g. the Spotify URI of the song that caused the crash.
|
||||
|
||||
# Building
|
||||
A quick walk through of the build process is outlined here, while a detailed compilation guide can be found [here](https://github.com/librespot-org/librespot/blob/master/COMPILING.md).
|
||||
A quick walkthrough of the build process is outlined below, while a detailed compilation guide can be found [here](https://github.com/librespot-org/librespot/blob/master/COMPILING.md).
|
||||
|
||||
## Additional Dependencies
|
||||
We recently switched to using [Rodio](https://github.com/tomaka/rodio) for audio playback by default, hence for macOS and Windows, you should just be able to clone and build librespot (with the command below).
|
||||
|
|
@ -49,7 +49,7 @@ On Fedora systems, the following command will install these dependencies :
|
|||
sudo dnf install alsa-lib-devel make gcc
|
||||
```
|
||||
|
||||
librespot currently offers the following selection of [audio backends](https://github.com/librespot-org/librespot/wiki/Audio-Backends).
|
||||
librespot currently offers the following selection of [audio backends](https://github.com/librespot-org/librespot/wiki/Audio-Backends):
|
||||
```
|
||||
Rodio (default)
|
||||
ALSA
|
||||
|
|
@ -62,7 +62,7 @@ SDL
|
|||
Pipe
|
||||
Subprocess
|
||||
```
|
||||
Please check the corresponding [compiling entry](https://github.com/librespot-org/librespot/wiki/Compiling#general-dependencies) for backend specific dependencies.
|
||||
Please check the corresponding [Compiling](https://github.com/librespot-org/librespot/wiki/Compiling#general-dependencies) entry on the wiki for backend specific dependencies.
|
||||
|
||||
Once you've installed the dependencies and cloned this repository you can build *librespot* with the default backend using Cargo.
|
||||
```shell
|
||||
|
|
@ -93,7 +93,7 @@ A full list of runtime options is available [here](https://github.com/librespot-
|
|||
_Please Note: When using the cache feature, an authentication blob is stored for your account in the cache directory. For security purposes, we recommend that you set directory permissions on the cache directory to `700`._
|
||||
|
||||
## Contact
|
||||
Come and hang out on gitter if you need help or want to offer some.
|
||||
Come and hang out on gitter if you need help or want to offer some:
|
||||
https://gitter.im/librespot-org/spotify-connect-resources
|
||||
|
||||
## Disclaimer
|
||||
|
|
|
|||
Loading…
Reference in a new issue