From d967b291aea1d61365d5232c002a7eadad6f7416 Mon Sep 17 00:00:00 2001
From: unknowntrojan <14975032+unknowntrojan@users.noreply.github.com>
Date: Wed, 14 Jun 2023 15:34:20 +0200
Subject: add compile info to readme, support stable & dev

---
 Cargo.toml | 13 ++++++++-----
 README.md  |  8 ++++++++
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 887ba7c..ed8aad6 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name    = "binja_sigmaker"
-version = "0.1.0"
+name    = "binja_coolsigmaker"
+version = "0.1.1"
 authors = ["unknowntrojan"]
 edition = "2021"
 
@@ -8,9 +8,12 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-log         = "0.4.17"
-clipboard   = "0.5.0"
-binaryninja = { git = "https://github.com/Vector35/binaryninja-api.git", branch = "dev" }
+log       = "0.4.17"
+clipboard = "0.5.0"
+# Dev
+# binaryninja = { git = "https://github.com/Vector35/binaryninja-api.git", branch = "dev" }
+# Stable
+binaryninja = { git = "https://github.com/Vector35/binaryninja-api.git", tag = "v3.4.4271-stable" }
 rayon       = "1.7.0"
 iced-x86    = "1.17.0"
 strum       = { version = "0.24.1", features = ["derive"] }
diff --git a/README.md b/README.md
index 1ec3dcd..b37f819 100644
--- a/README.md
+++ b/README.md
@@ -24,3 +24,11 @@ This is how it looks to create a signature, then scan for it:
 2. Place the binary in your Binary Ninja installation's plugin folder
 
 Once GitHub Actions are set up and a loader plugin has been written, you will be able to install the plugin via the official plugin manager.
+
+## Compiling yourself
+
+This project requires the nightly channel of Rust.
+
+Check the Cargo.toml file and adjust the binaryninja dependency so it points to whatever Binja update channel you want to compile for. !MAKE SURE! you remove the Cargo.lock file. Otherwise, it'll keep using whatever version was selected when you built or rust-analyzer ran.
+
+The Stable tag needs to be updated periodically, there is no "newest-stable" tag.
-- 
cgit v1.3.1