Skip to content
This repository has been archived by the owner on Feb 20, 2024. It is now read-only.

Commit

Permalink
Update name and description
Browse files Browse the repository at this point in the history
  • Loading branch information
ericglau committed Jan 23, 2022
1 parent 9d56f7e commit b429a8f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Language support for Cairo
# Language support for Cairo and StarkNet

[Cairo](https://www.cairo-lang.org/) language support for VS Code.

This project implements a Cairo language server and VS Code extension to help with writing Cairo programs for StarkNet.
This project implements a Cairo language server and VS Code extension to help with writing Cairo contracts for StarkNet.

**Note**: This is an early preview release and is still in active development.

Expand All @@ -18,14 +18,15 @@ This project implements a Cairo language server and VS Code extension to help wi
- Code completion for imports
- Hover documentation (minimal for now)

Right-click menu commands to interact with Cairo:
- Compile Cairo program
- Compile StarkNet contract
- Run Cairo program
Right-click menu commands using [Nile](https://github.com/OpenZeppelin/nile):
- Nile - Clean
- Nile - Compile all
- Nile - Compile this contract
- Run tests with pytest

## Setup

1. Follow [Cairo environment setup steps](https://www.cairo-lang.org/docs/quickstart.html).
2. If using a virtual environment, start VS Code from within that terminal according to the instructions in the above link.
3. Install this extension along with [StarkWare's Cairo extension (.vsix file)](https://github.com/starkware-libs/cairo-lang/releases).
4. Open a .cairo file and start editing.
1. Install Nile by following its [Getting started](https://github.com/OpenZeppelin/nile#getting-started) steps, or follow the [Cairo environment setup steps](https://www.cairo-lang.org/docs/quickstart.html).
3. If using a virtual environment, start VS Code from within that terminal according to the instructions [here](https://www.cairo-lang.org/docs/quickstart.html#visual-studio-code-setup).
4. Install this extension along with [StarkWare's Cairo extension (.vsix file)](https://github.com/starkware-libs/cairo-lang/releases).
5. Open a .cairo file and start editing.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "cairo-ls",
"displayName": "Language support for Cairo",
"description": "Cairo language support for VS Code",
"displayName": "Language support for Cairo and StarkNet",
"description": "Cairo and StarkNet language support for VS Code",
"author": "Eric Lau",
"license": "EPL-2.0",
"version": "0.0.12",
"version": "0.0.13",
"preview": true,
"icon": "images/logo.png",
"repository": {
Expand Down

0 comments on commit b429a8f

Please sign in to comment.