Update README.md and add test that it contains agave_tag.txt

Author: smoelius

README.md

@@ -2,43 +2,29 @@
 
 A wrapper around [`anchor test`] for computing test coverage
 
-`anchor-coverage` requires a patched Solana test validator (see below). The patch is known to work with Agave commit [cd29142](https://github.com/anza-xyz/agave/commit/cd291424d3d71c1a3be0c2c919916dcaa272d162).
+`anchor-coverage` requires a patched `solana-test-validator` (see below). The patch is known to work with [Agave v3.0.6](https://github.com/anza-xyz/agave/tree/v3.0.6).
 
 ## Steps to use
 
-1. Clone the [Agave repository] and checkout the commit named above.
+1. Download, unzip, and untar a patched `solana-test-validator` from `sbpf-coverage`'s [Releases].
 
-2. Add the following to the `[patch.crates-io]` section near the end of Agave's Cargo.toml, and install Agave [from source]:
-
-   ```toml
-   solana-sbpf = { git = "https://github.com/trail-of-forks/sbpf-coverage" }
-   ```
-
-   For Linux users, the following commands should suffice:
-
-   ```sh
-   sed -i '/^\[patch\.crates-io\]$/a solana-sbpf = { git = "https://github.com/trail-of-forks/sbpf-coverage" }' Cargo.toml
-   ./scripts/cargo-install-all.sh .
-   export PATH=$PWD/bin:$PATH
-   ```
-
-3. Add the following to the `[profile.release]` section of your Anchor project's root Cargo.toml:
+2. Add the following to the `[profile.release]` section of your Anchor project's root Cargo.toml:
 
    ```toml
    debug = true
    ```
 
    This tells Cargo to build with debug information.
 
-4. Run `anchor-coverage` as follows:
+3. Run `anchor-coverage` as follows:
 
    ```sh
    anchor-coverage [ANCHOR_TEST_ARGS]...
    ```
 
    This will create an `sbf_trace_dir` directory with an LCOV file for each executable run.
 
-5. Run the following command to generate and open an HTML coverage report:
+4. Run the following command to generate and open an HTML coverage report:
 
    ```sh
    genhtml --output-directory coverage sbf_trace_dir/*.lcov && open coverage/index.html
@@ -78,5 +64,6 @@ The following is an example. The line with the assignment to `signer` is hit onl
 
 [Agave repository]: https://github.com/anza-xyz/agave
 [LLVM instrumentation-based coverage]: https://llvm.org/docs/CoverageMappingFormat.html
+[Releases]: https://github.com/trail-of-forks/sbpf-coverage/releases
 [`anchor test`]: https://www.anchor-lang.com/docs/references/cli#test
 [from source]: https://docs.anza.xyz/cli/install#building-from-source

tests/ci.rs

@@ -1,6 +1,11 @@
 use assert_cmd::Command;
 use regex::Regex;
-use std::{env::remove_var, ffi::OsStr, fs::read_to_string, path::Path};
+use std::{
+    env::remove_var,
+    ffi::OsStr,
+    fs::{read, read_to_string},
+    path::Path,
+};
 use walkdir::WalkDir;
 
 #[ctor::ctor]
@@ -88,6 +93,17 @@ fn no_package_lock_json() {
     }
 }
 
+#[test]
+fn readme_contains_agave_tag() {
+    let agave_tag = read_to_string("agave_tag.txt")
+        .map(|s| s.trim_end().to_owned())
+        .unwrap();
+    let readme = read("README.md").unwrap();
+    assert!(readme
+        .windows(agave_tag.len())
+        .any(|w| w == agave_tag.as_bytes()));
+}
+
 #[test]
 fn readme_reference_links_are_sorted() {
     let re = Regex::new(r"^\[[^\]]*\]:").unwrap();