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.

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

fix: modify installation.md file #2616

Merged
merged 10 commits into from
Nov 4, 2024
32 changes: 27 additions & 5 deletions docs/src/getting-started/installation.md
kkawula marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,37 @@ First, add the Starknet Foundry plugin to asdf:
asdf plugin add starknet-foundry
```

Install the latest version:
#### Version Management

- Common Error
kkawula marked this conversation as resolved.
Show resolved Hide resolved

Users may encounter this error when trying to use `snforge` or `sncast` without setting a version:

```shell
No version is set for command snforge
Consider adding one of the following versions in your config file at starknet-foundry 0.32.0
```

The error indicates that `Starknet Foundry` version is unset. Set the version as outlined to fix this

#### Switching Versions

To switch between different versions:

```shell
asdf install starknet-foundry latest
# Install a different version
asdf install starknet-foundry 0.32.0

# Switch global version
asdf global starknet-foundry 0.32.0
od-hunter marked this conversation as resolved.
Show resolved Hide resolved

# Or switch local version
asdf local starknet-foundry 0.32.0
```

See [asdf guide](https://asdf-vm.com/guide/getting-started.html) for more details.
"For more details on using `asdf` see this [asdf](https://asdf-vm.com/guide/getting-started.html#_6-set-a-version)"
kkawula marked this conversation as resolved.
Show resolved Hide resolved

### Installation on Windows
#### Installation on Windows
od-hunter marked this conversation as resolved.
Show resolved Hide resolved

As for now, Starknet Foundry on Windows needs manual installation, but necessary steps are kept to minimum:

Expand All @@ -76,7 +98,7 @@ snforge --version
sncast --version
```

### Universal-Sierra-Compiler update
#### Universal-Sierra-Compiler update
od-hunter marked this conversation as resolved.
Show resolved Hide resolved

If you would like to bump the USC manually (e.g. when the new Sierra version is released) you can do it by running:

Expand Down