Skip to content

Commit

Permalink
docs: update LSP instructions (#4920)
Browse files Browse the repository at this point in the history
Context: version of Noir LSP extension was updated (0.0.11) to have better nargo executable visibility/selection.
  • Loading branch information
jzaki authored Mar 4, 2024
1 parent 15df3c0 commit a5e26e7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
7 changes: 6 additions & 1 deletion docs/docs/developers/contracts/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ An **Aztec smart contract** is a smart contract with **private** state variables

**Aztec.nr** is a framework for writing Aztec smart contracts, written in Noir.

Futher Nomenclature can be found [here](https://github.com/AztecProtocol/dev-rel/blob/main/NOMENCLATURE.md).

# Getting started

## Install aztec-nargo
Expand All @@ -34,14 +36,17 @@ For those coming from vanilla Noir, the version used for aztec.nr is tracked sep

Install the [Noir Language Support extension](https://marketplace.visualstudio.com/items?itemName=noir-lang.vscode-noir) to get syntax highlighting, syntax error detection and go-to definitions for your Aztec contracts.

Once the extension is installed, go to your VSCode settings, search for "noir" and update the `Noir: Nargo Path` field to point to your `aztec-nargo` executable.
Once the extension is installed, check your nargo binary by hovering over `Nargo` in the status bar on the bottom right of the application window. Click to choose the path to `aztec-nargo` (or regular `nargo`, if you have that installed).

You can print the path of your `aztec-nargo` executable by running:

```bash
which aztec-nargo
```

To specify a custom nargo executable, go to the VSCode settings and search for "noir", or click extension settings on the `noir-lang` LSP plugin.
Update the `Noir: Nargo Path` field to point to your desired `aztec-nargo` executable.

## Install Noir tooling

There are a number of tools to make writing Aztec.nr contracts in Noir more pleasant. See [here](https://github.com/noir-lang/awesome-noir#get-coding).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,14 +197,17 @@ Congratulations, you have now written, compiled, and deployed your first Aztec.n

Install the [Noir Language Support extension](https://marketplace.visualstudio.com/items?itemName=noir-lang.vscode-noir) to get syntax highlighting, syntax error detection and go-to definitions for your Aztec contracts.

Once the extension is installed, go to your VSCode settings, search for "noir" and update the `Noir: Nargo Path` field to point to your `aztec-nargo` executable.
Once the extension is installed, check your nargo binary by hovering over `Nargo` in the status bar on the bottom right of the application window. Click to choose the path to `aztec-nargo` (or regular `nargo`, if you have that installed).

You can print the path of your `aztec-nargo` executable by running:

```bash
which aztec-nargo
```

To specify a custom nargo executable, go to the VSCode settings and search for "noir", or click extension settings on the `noir-lang` LSP plugin.
Update the `Noir: Nargo Path` field to point to your desired `aztec-nargo` executable.

## What's next?

Now you can explore.
Expand Down

0 comments on commit a5e26e7

Please sign in to comment.