github-mirrors/librespot
1
0
Fork 0
mirror of https://github.com/librespot-org/librespot.git synced 2024-12-18 17:11:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document MSRV 1.53 and cargo clippy requirement

Browse source
This commit is contained in:
Roderick van Domburg 2022-01-14 23:45:31 +01:00
parent 0de55c6183
commit 8811b89b2d
No known key found for this signature in database
GPG key ID: A9EF5222A26F0451
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
COMPILING.md
View file

@ -7,7 +7,7 @@ In order to compile librespot, you will first need to set up a suitable Rust bui
### Install Rust ### Install Rust
The easiest, and recommended way to get Rust is to use [rustup](https://rustup.rs). Once that’s installed, Rust's standard tools should be set up and ready to use. The easiest, and recommended way to get Rust is to use [rustup](https://rustup.rs). Once that’s installed, Rust's standard tools should be set up and ready to use.
*Note: The current minimum required Rust version at the time of writing is 1.48, you can find the current minimum version specified in the `.github/workflow/test.yml` file.* *Note: The current minimum required Rust version at the time of writing is 1.53.*
#### Additional Rust tools - `rustfmt` #### Additional Rust tools - `rustfmt`
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: 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:
@ -15,7 +15,7 @@ To ensure a consistent codebase, we utilise [`rustfmt`](https://github.com/rust-
rustup component add rustfmt rustup component add rustfmt
rustup component add clippy rustup component add clippy
``` ```
Using `rustfmt` is not optional, as our CI checks against this repo's rules. Using `cargo fmt` and `cargo clippy` is not optional, as our CI checks against this repo's rules.
### General dependencies ### General dependencies
Along with Rust, you will also require a C compiler. Along with Rust, you will also require a C compiler.
@ -63,7 +63,7 @@ sudo dnf install alsa-lib-devel
The recommended method is to first fork the repo, so that you have a copy that you have read/write access to. After that, it’s a simple case of cloning your fork. The recommended method is to first fork the repo, so that you have a copy that you have read/write access to. After that, it’s a simple case of cloning your fork.
```bash ```bash
git clone git@github.com:YOURUSERNAME/librespot.git git clone git@github.com:YOUR_USERNAME/librespot.git
``` ```
## Compiling & Running ## Compiling & Running