Unverified Commit bf7db886 authored by Kyle Siefring's avatar Kyle Siefring Committed by GitHub

Update instructions for using rustfmt and clippy (#549)

parent 00b17cac
......@@ -79,25 +79,37 @@ make -j8
## Coding style
Check code formatting with [rustfmt](https://github.com/rust-lang-nursery/rustfmt) before submitting a PR.
rav1e currently uses a [forked version](https://github.com/mbebenita/rustfmt) of rustfmt.
rav1e currently uses the nightly version of rustfmt.
To install rustfmt:
To install nightly:
```
git clone https://github.com/mbebenita/rustfmt
cd rustfmt
cargo +nightly build // Depends on the Rust nightly toolchain.
cargo +nightly install -f // Overwrite the installed rustfmt.
rustup install nightly
```
To install the nightly version of rustfmt:
```
rustup component add rustfmt-preview --toolchain nightly
```
then
```
cd rav1e
cargo +nightly fmt -- --check
```
You should also try [clippy](https://github.com/rust-lang-nursery/rust-clippy).
Rust also uses nightly for clippy.
To install clippy:
```
rustup component add clippy-preview --toolchain nightly
```
then
```
cargo +nightly clippy
```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment