Skip to content

Commit

Permalink
changes from PR
Browse files Browse the repository at this point in the history
  • Loading branch information
signorecello committed Jun 25, 2024
1 parent 1037bc9 commit b63cdd4
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ title: Quickstart
The easiest way to start developing on Aztec locally is through `npx aztec-app`. This is a convenient way of installing the development environment (A.K.A. Sandbox) and starting new projects from a boilerplate.

If you'd like to develop remotely (for example, if you're on Windows or have trouble working with Docker), follow the [codespaces guide](./getting_started/codespaces.md).

To locally install the Sandbox without other tools, see [here](./getting_started/manual_install.md).

To locally install the Sandbox without other tools, see [here](./getting_started/manual_install.md).

## Prerequisites

Expand All @@ -23,6 +23,21 @@ npx aztec-app

This script gives you some options to bootstrap a new project, start/stop the sandbox, or see the logs. Run `npx aztec-app -h` for a list of options.

## Install Noir LSP (recommended)

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, 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 have a development network running, so you're ready to start coding your first app with Aztec.nr and Aztec.js!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ Initializers are commonly used to set an admin, such as this example:
#include_code constructor /noir-projects/noir-contracts/contracts/token_contract/src/main.nr rust

Here, the initializer is calling a public function. It can also call a private function. Learn more about calling functions from functions [here](./call_functions.md).

To see an initializer in action, check out the [Counter Contract Tutorial](../../../tutorials/contract_tutorials/counter_contract.md).
6 changes: 6 additions & 0 deletions docs/test-results/.last-run.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"status": "failed",
"failedTests": [
"9ba72938132eb4de72d3-6514e60e465f8a2fe54d"
]
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b63cdd4

Please sign in to comment.