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

Update vyper.md #3183

Merged
merged 2 commits into from
May 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/vyper.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Vyper Compiler
==============

Vyper contracts can be compiled in Remix in the **Vyper compiler**.
Vyper contracts can be compiled in Remix with the **Vyper compiler**.

![](images/a-vyper-pi-basic.png)

The plugin can be activated by going to:
1. the Plugin Manager and clicking on the Vyper compiler's activate button.
2. the File Explorer, then right-clicking on a .vy file and selecting compile in the pop-up menu.
2. the File Explorer, then by right-clicking on a .vy file and selecting compile in the pop-up menu.
3. https://remix.ethereum.org/#activate=vyper

## Compiling a Vyper file
A Vyper file (with a .vy extension) needs to be the active file in the Editor. To get some example files, click on the **Clone Vyper examples repo** button. This will clone a repo and put it in a new Workspace. Go to the File Explorer to see the files.
A Vyper file (with a .vy extension) needs to be the active file in the Editor. To get some example files, click on the **Clone Vyper examples repo** button. This will clone a repo and put it in a new Workspace. Go to the File Explorer to see the files.

## Specifying Vyper version, EVM versions, and optimize

Expand Down Expand Up @@ -51,11 +51,11 @@ There are 4 ways to compile:
4. CTRL + s when a .vy file is in the active tab of the Editor.

## Remote vs Local compiler
The default is to use the remote compiler. To see the settings open up the Advanced Settings accordion box.
The default is to use the remote compiler. To see the settings open up the Advanced Settings accordion box.

### Remote Compiler

The remote compilation is done using our remote containerized service that supports the official Vyper plugin for the Ape framework that ApeWorX maintains.
The remote compilation is done using our remote containerized service that supports the official Vyper plugin for the Ape framework which ApeWorX maintains.

### Local Compiler

Expand All @@ -66,7 +66,6 @@ When the next version of Remix Desktop is ready, you’ll be able to run everyth
## Compiler errors
When there are compiler errors in the Vyper plugin, a card will appear at the bottom of the compiler.

Errors appear one at a time. Fix one error, and the next one, if it exists, will appear.

Errors appear one at a time. Fix one error and the next one, if it exists, will appear.

![](images/a-vyper-compiler-error.png)
![](images/a-vyper-compiler-error.png)