From db8930e355b1c0f9e3bd2da677f1834f60a96cfa Mon Sep 17 00:00:00 2001
From: Russel Arbore <russel.jma@gmail.com>
Date: Sat, 1 Jun 2024 12:42:30 -0700
Subject: [PATCH] Some useful comments

---
 hercules_ir/src/ir.rs               | 3 +++
 hercules_samples/matmul/src/main.rs | 4 ++++
 2 files changed, 7 insertions(+)

diff --git a/hercules_ir/src/ir.rs b/hercules_ir/src/ir.rs
index e7210261..6f44bff7 100644
--- a/hercules_ir/src/ir.rs
+++ b/hercules_ir/src/ir.rs
@@ -115,7 +115,10 @@ pub enum Constant {
  */
 #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub enum DynamicConstant {
+    // The usize here is a constant value.
     Constant(usize),
+    // The usize here is an index (which dynamic constant parameter of a
+    // function is this).
     Parameter(usize),
 }
 
diff --git a/hercules_samples/matmul/src/main.rs b/hercules_samples/matmul/src/main.rs
index 3b95a806..732aece4 100644
--- a/hercules_samples/matmul/src/main.rs
+++ b/hercules_samples/matmul/src/main.rs
@@ -2,6 +2,10 @@ extern crate async_std;
 extern crate clap;
 extern crate hercules_rt;
 
+// To compile currently, run from the Hercules project root directory:
+// cargo run --bin hercules_driver hercules_samples/matmul/matmul.hir "Codegen(\"matmul.hbin\")"
+// Then, you can execute this example with:
+// cargo run --bin hercules_matmul
 hercules_rt::use_hbin!("matmul.hbin");
 
 fn main() {
-- 
GitLab