From 81ebbfb910bc407e507acd02d56ace4a27739fff Mon Sep 17 00:00:00 2001
From: Tyler Philbrick <t5j6p9@gmail.com>
Date: Sat, 22 Oct 2022 20:19:31 -0700
Subject: [PATCH] Tell rustup to automatically use the nightly channel

Since MCHPRS only compiles using rust nightly, it can ship a
`rust-toolchain` file that will tell rustup to automatically switch to
the nightly channel.

This behavior is documented here:
https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file

This also prevents you needing to provide instructions to add a manual
override in the README.
---
 README.md      | 1 -
 rust-toolchain | 1 +
 2 files changed, 1 insertion(+), 1 deletion(-)
 create mode 100644 rust-toolchain

diff --git a/README.md b/README.md
index 9bcfef3b..9413d1c9 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,6 @@ If the Rust compiler is not already installed, you can find out how [on their of
 ```shell
 git clone https://github.com/MCHPR/MCHPRS.git
 cd MCHPRS
-rustup override set nightly
 cargo build --release
 ```
 
diff --git a/rust-toolchain b/rust-toolchain
new file mode 100644
index 00000000..bf867e0a
--- /dev/null
+++ b/rust-toolchain
@@ -0,0 +1 @@
+nightly