From d61861f8ada33c123da57bf8e5021c4d10908c59 Mon Sep 17 00:00:00 2001
From: Ranjit Jhala <rjhala@ucsd.edu>
Date: Tue, 3 Dec 2024 10:34:41 -0800
Subject: [PATCH] update doc

---
 tools/vscode/README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/tools/vscode/README.md b/tools/vscode/README.md
index 595fb5680b..f180f72ef5 100644
--- a/tools/vscode/README.md
+++ b/tools/vscode/README.md
@@ -4,7 +4,7 @@ VS Code extension with language support for flux rust intermediate representatio
 
 ## Install
 
-To get the extension running you need to **build** the `vsix` file and **install** it manually
+**Step 1.** To get the extension running you need to **build** the `vsix` file and **install** it manually
 
 ```bash
 $ npm install -g typescript
@@ -12,6 +12,22 @@ $ npm install -g vsce
 $ vsce package
 ```
 
+**Step 2.** Install `flux`
+
+Following [these instructions](https://flux-rs.github.io/flux/guide/install.html)
+
+**Step 3.** Configure `flux` in your workspace
+
+Ensure you have the following in your `flux.toml` for the workspace you want to use the extension in:
+
+```toml
+dump_checker_trace = true
+check_diff = true
+cache = true
+```
+
+**Step 4.** Run the extension!
+
 You can then **enable** the extension by runnning the `Toggle Flux View` command in the command palette.
 
 ## Features