Skip to content

Commit 9cb98e9

Browse files
committed
Fix typos and define what's "breaking"
1 parent 2fcd241 commit 9cb98e9

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In order to prepare for a PR, you will need to do a couple of things first:
3131

3232
Make any changes that you are going to make to the code, but do not commit yet.
3333

34-
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.
34+
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)`.
3535

3636
Make sure that the code is correctly formatted by running:
3737
```bash

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Current maintainers are [listed on GitHub](https://github.com/orgs/librespot-org
77
# librespot
88
*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.
99

10-
_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._
10+
_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._
1111

1212
## Quick start
1313
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
2020
# Documentation
2121
Documentation is currently a work in progress, contributions are welcome!
2222

23-
There is some brief documentation on how the protocol works in the [docs](https://github.com/librespot-org/librespot/tree/master/docs) folder,
23+
There is some brief documentation on how the protocol works in the [docs](https://github.com/librespot-org/librespot/tree/master/docs) folder.
2424

2525
[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).
2626
[CONTRIBUTING.md](https://github.com/librespot-org/librespot/blob/master/CONTRIBUTING.md) also contains our contributing guidelines.
@@ -30,26 +30,26 @@ If you wish to learn more about how librespot works overall, the best way is to
3030
# Issues & Discussions
3131
**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.**
3232

33-
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.
33+
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.
3434

3535
# Building
36-
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).
36+
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).
3737

3838
## Additional Dependencies
3939
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).
4040
For Linux, you will need to run the additional commands below, depending on your distro.
4141

42-
On Debian/Ubuntu, the following command will install these dependencies :
42+
On Debian/Ubuntu, the following command will install these dependencies:
4343
```shell
4444
sudo apt-get install build-essential libasound2-dev
4545
```
4646

47-
On Fedora systems, the following command will install these dependencies :
47+
On Fedora systems, the following command will install these dependencies:
4848
```shell
4949
sudo dnf install alsa-lib-devel make gcc
5050
```
5151

52-
librespot currently offers the following selection of [audio backends](https://github.com/librespot-org/librespot/wiki/Audio-Backends).
52+
librespot currently offers the following selection of [audio backends](https://github.com/librespot-org/librespot/wiki/Audio-Backends):
5353
```
5454
Rodio (default)
5555
ALSA
@@ -62,7 +62,7 @@ SDL
6262
Pipe
6363
Subprocess
6464
```
65-
Please check the corresponding [compiling entry](https://github.com/librespot-org/librespot/wiki/Compiling#general-dependencies) for backend specific dependencies.
65+
Please check the corresponding [Compiling](https://github.com/librespot-org/librespot/wiki/Compiling#general-dependencies) entry on the wiki for backend specific dependencies.
6666

6767
Once you've installed the dependencies and cloned this repository you can build *librespot* with the default backend using Cargo.
6868
```shell
@@ -93,7 +93,7 @@ A full list of runtime options is available [here](https://github.com/librespot-
9393
_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`._
9494

9595
## Contact
96-
Come and hang out on gitter if you need help or want to offer some.
96+
Come and hang out on gitter if you need help or want to offer some:
9797
https://gitter.im/librespot-org/spotify-connect-resources
9898

9999
## Disclaimer

0 commit comments

Comments
 (0)