README updates

firedancer-io · Jul 29, 2024 · 6a2ce9f · 6a2ce9f
1 parent 1d2e691
commit 6a2ce9f
Showing 1 changed file with 10 additions and 10 deletions.
diff --git a/SOLFUZZ_README.md b/SOLFUZZ_README.md
@@ -11,11 +11,11 @@ in the [`Cargo.toml`](https://github.com/firedancer-io/solfuzz-agave/blob/762219
 ```mermaid
 %%{init: { 'gitGraph': {'mainBranchName':'anza-xyz/agave'} }}%%
 gitGraph LR:
-	commit
-	commit
+	commit id:"1-commit"
+	commit id:"2-commit"
 	commit id:"v2.0-chkpt" type:Highlight tag: "solfuzz-agave"
-	commit
-	commit
+	commit id:"3-commit"
+	commit id:"4-commit"
 	
 ```
 
@@ -36,14 +36,14 @@ gitGraph LR:
 
 ```
 
-Here, the `solfuzz-agave-v2.0-patches` branch tracks the specific agave-v2.0 revision that `solfuzz-agave` is based on.
+Here, the `solfuzz-agave-v2.0-patches` branch tracks the specific agave-v2.0 revision that `solfuzz-agave` is based on in the [firedancer-io fork of agave](https://github.com/firedancer-io/agave).
 We update the `Cargo.toml` file in the `solfuzz-agave` repository to point to the **HEAD** of `solfuzz-agave-v2.0-patches`.
 
-⚠️ Note: We want the dependencies to point to the **commit hash** of the patches branch, **not** the branch itself to keep the dependencies stable.
+⚠️ Note: We want the dependencies to point to the **commit hash** of the patches branch, **not** the branch itself. This keeps the dependencies stable.
 
 ## Applying patches
 Checkout a new branch from the `solfuzz-agave-v2.0-patches` branch and apply patches on top of it.
-Open a PR to merge the patches into the `solfuzz-agave-v2.0-patches` branch.
+Open a PR to merge the patch into the `solfuzz-agave-v2.0-patches` branch.
 
 
 ```mermaid
@@ -66,12 +66,12 @@ gitGraph LR:
 
 ```
 
-After merging the new patches, update the `Cargo.toml` file in the `solfuzz-agave` repository to point to the HEAD of `solfuzz-agave-v2.0-patches`.
+After merging the new patches, update the `Cargo.toml` file in the `solfuzz-agave` repository to point to the (new) HEAD of `solfuzz-agave-v2.0-patches`.
 
 
 
 ## Rebasing patch branch
-Say we have a new commit `v2.0-new-chkpt` in the `firedancer-io/agave` repository. 
+Say we have a new commit `v2.0-new-chkpt` that we want to track.
 
 ```mermaid
 %%{init: { 'gitGraph': {'mainBranchName':'firedancer-io/agave', 'parallelCommits': true} }}%%
@@ -109,4 +109,4 @@ gitGraph LR:
 
 ```
 
-After rebasing, update the `Cargo.toml` file in the `solfuzz-agave` repository to point to the HEAD of `solfuzz-agave-v2.0-patches`.
+Open a PR for the rebase (pointing to the new base commit). After rebasing, update the `Cargo.toml` file in the `solfuzz-agave` repository to point to the (new) HEAD of `solfuzz-agave-v2.0-patches`.