Skip to content

Commit

Permalink
Document vscode settings (#479)
Browse files Browse the repository at this point in the history
Signed-off-by: John Kastner <jkastner@amazon.com>
  • Loading branch information
john-h-kastner-aws authored Nov 20, 2024
1 parent 2af65bc commit 5eb1d90
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,24 @@ That README also explains how to debug build failures, and how to save DRT-gener

Additional commands available with `cargo fuzz help`.

## VSCode

To work with `cedar-drt` in VSCode, first configure two settings so that the rust analyzer plugin doesn't error when trying to find the Lean installation and so that it works properly in the `fuzz` crate.
Add the following entries to your `.vscode/settings.json`. First run `source set_env_vars.sh && echo $LEAN_LIB_DIR` to get the correct value for `LEAN_LIB_DIR`.

```json
{
"rust-analyzer.linkedProjects": [
"./cedar-drt/fuzz/Cargo.toml"
],
"rust-analyzer.cargo.extraEnv": {
"LEAN_LIB_DIR": <$LEAN_LIB_DIR as populated by set_env_vars.sh>
}
}
```

See the [cedar-lean README](./cedar-lean/README.md) for some additional consideration when working with the Lean formalization.

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
Expand Down

0 comments on commit 5eb1d90

Please sign in to comment.