Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ranjitjhala committed Dec 3, 2024
1 parent 5326146 commit d61861f
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion tools/vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,30 @@ 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
$ 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
Expand Down

0 comments on commit d61861f

Please sign in to comment.