README: Suggest pinning avr-hal revision

avr-hal is still a very young project and we'll see quite a few breaking changes still. To make those less painful for downstream users, suggest pinning the `avr-hal` version to a specific commit so upstream updates won't accidentally break a downstream user's code when they do `cargo update`. Signed-off-by: Rahix <[email protected]>
Rahix · Oct 18, 2020 · 0c6cf16 · 0c6cf16
1 parent 7337cd7
commit 0c6cf16
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,11 @@ This is a step-by-step guide for creating a new project targeting Arduino Leonar
 
    [dependencies.arduino-leonardo]
    git = "https://github.com/Rahix/avr-hal"
+   rev = "<insert latest git-commit hash here>"
+   # ^- Pin the dependency to a specific version.  You should use the latest
+   # commit hash from the avr-hal master branch.  You can find it here:
+   #
+   #    https://github.com/Rahix/avr-hal/commits/master
 
    # Configure the build for minimal size
    [profile.dev]