From 16e5696544edba788744abb0218cbd2f2252a77a Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Mon, 10 Apr 2023 09:49:17 -0700 Subject: [PATCH] Update reference to libgit2 version in README. --- CONTRIBUTING.md | 1 + README.md | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bbbb673a68..d8ab922325 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,7 @@ The following steps can be used to update libgit2: * Update the dependency version in [`Cargo.toml`](https://github.com/rust-lang/git2-rs/blob/master/Cargo.toml) to match the version in the last step (do not include the `+` metadata). Also update the version of the `git2` crate itself so it will pick up the change to `libgit2-sys` (also keeping in mind if it is a SemVer breaking release). * Update the version in [`README.md`](https://github.com/rust-lang/git2-rs/blob/master/README.md) if needed. + There are two places, the `Cargo.toml` example and the description of the libgit2 version it binds with. * If there was a SemVer-breaking version bump for either library, also update the `html_root_url` attribute in the `lib.rs` of each library. 3. Run tests. `cargo test -p git2 -p git2-curl` is a good starting point. diff --git a/README.md b/README.md index d94ff5a9f1..a5321126a3 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,10 @@ stable release as well. ## Version of libgit2 -Currently this library requires libgit2 1.4. The source for libgit2 is -included in the libgit2-sys crate so there's no need to pre-install the libgit2 -library, the libgit2-sys crate will figure that and/or build that for you. +Currently this library requires libgit2 1.6.3 (or newer patch versions). The +source for libgit2 is included in the libgit2-sys crate so there's no need to +pre-install the libgit2 library, the libgit2-sys crate will figure that and/or +build that for you. ## Building git2-rs