Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document vscode settings #479

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Document vscode settings #479

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9cd0ab
document vscode settings
john-h-kastner-aws Nov 19, 2024
7887a13
Typos
john-h-kastner-aws Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
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