Skip to content

Commit b662b3b

Browse files
committed
docs: fix MD031 markdown lint
[MD031/blanks-around-fences](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md031.md) : Fenced code blocks should be surrounded by blank lines
1 parent 414432a commit b662b3b

File tree

4 files changed

+26
-0
lines changed

4 files changed

+26
-0
lines changed

.markdownlint.jsonc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
// MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines
3+
"MD031": true
4+
}

COMPILING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,30 @@ The easiest, and recommended way to get Rust is to use [rustup](https://rustup.r
99

1010
#### Additional Rust tools - `rustfmt`
1111
To ensure a consistent codebase, we utilise [`rustfmt`](https://github.com/rust-lang/rustfmt) and [`clippy`](https://github.com/rust-lang/rust-clippy), which are installed by default with `rustup` these days, else they can be installed manually with:
12+
1213
```bash
1314
rustup component add rustfmt
1415
rustup component add clippy
1516
```
17+
1618
Using `cargo fmt` and `cargo clippy` is not optional, as our CI checks against this repo's rules.
1719

1820
### General dependencies
1921
Along with Rust, you will also require a C compiler.
2022

2123
On Debian/Ubuntu, install with:
24+
2225
```shell
2326
sudo apt-get install build-essential
2427

2528
```
29+
2630
On Fedora systems, install with:
31+
2732
```shell
2833
sudo dnf install gcc
2934
```
35+
3036
### Audio library dependencies
3137
Depending on the chosen backend, specific development libraries are required.
3238

@@ -47,11 +53,14 @@ Depending on the chosen backend, specific development libraries are required.
4753
###### For example, to build an ALSA based backend, you would need to run the following to install the required dependencies:
4854

4955
On Debian/Ubuntu:
56+
5057
```shell
5158
sudo apt-get install libasound2-dev pkg-config
5259

5360
```
61+
5462
On Fedora systems:
63+
5564
```shell
5665
sudo dnf install alsa-lib-devel
5766
```
@@ -86,11 +95,13 @@ This is the **default choice** and provides the best compatibility. It integrate
8695

8796
**Dependencies:**
8897
On Debian/Ubuntu:
98+
8999
```shell
90100
sudo apt-get install libssl-dev pkg-config
91101
```
92102

93103
On Fedora:
104+
94105
```shell
95106
sudo dnf install openssl-devel pkg-config
96107
```
@@ -119,6 +130,7 @@ Uses a Rust-based TLS implementation with certificate authority (CA) verificatio
119130
**No additional system dependencies required** - rustls is implemented in Rust (with some assembly for performance-critical cryptographic operations) and doesn't require external libraries like OpenSSL.
120131

121132
#### Building with specific TLS backends
133+
122134
```bash
123135
# Default (native-tls)
124136
cargo build

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Make any changes that you are going to make to the code, but do not commit yet.
3434
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:
37+
3738
```bash
3839
cargo fmt --all
3940
```
@@ -45,6 +46,7 @@ cargo build
4546
```
4647

4748
Once it has built, check for common code mistakes by running:
49+
4850
```bash
4951
cargo clippy
5052
```

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,19 @@ We recently switched to using [Rodio](https://github.com/tomaka/rodio) for audio
4040
For Linux, you will need to run the additional commands below, depending on your distro.
4141

4242
On Debian/Ubuntu, the following command will install these dependencies:
43+
4344
```shell
4445
sudo apt-get install build-essential libasound2-dev
4546
```
4647

4748
On Fedora systems, the following command will install these dependencies:
49+
4850
```shell
4951
sudo dnf install alsa-lib-devel make gcc
5052
```
5153

5254
librespot currently offers the following selection of [audio backends](https://github.com/librespot-org/librespot/wiki/Audio-Backends):
55+
5356
```
5457
Rodio (default)
5558
ALSA
@@ -62,9 +65,11 @@ SDL
6265
Pipe
6366
Subprocess
6467
```
68+
6569
Please check [COMPILING.md](COMPILING.md) for detailed information on TLS, audio, and discovery backend dependencies, or the [Compiling](https://github.com/librespot-org/librespot/wiki/Compiling#general-dependencies) entry on the wiki for additional backend specific dependencies.
6670

6771
Once you've installed the dependencies and cloned this repository you can build *librespot* with the default features using Cargo.
72+
6873
```shell
6974
cargo build --release
7075
```
@@ -80,14 +85,17 @@ librespot is also available via official package system on various operating sys
8085
## Usage
8186
A sample program implementing a headless Spotify Connect receiver is provided.
8287
Once you've built *librespot*, run it using :
88+
8389
```shell
8490
target/release/librespot --name DEVICENAME
8591
```
8692

8793
The above is a minimal example. Here is a more fully fledged one:
94+
8895
```shell
8996
target/release/librespot -n "Librespot" -b 320 -c ./cache --enable-volume-normalisation --initial-volume 75 --device-type avr
9097
```
98+
9199
The above command will create a receiver named ```Librespot```, with bitrate set to 320 kbps, initial volume at 75%, with volume normalisation enabled, and the device displayed in the app as an Audio/Video Receiver. A folder named ```cache``` will be created/used in the current directory, and be used to cache audio data and credentials.
92100

93101
A full list of runtime options is available [here](https://github.com/librespot-org/librespot/wiki/Options).

0 commit comments

Comments
 (0)