Skip to content

Commit

Permalink
Add Move Analyzer to Install Sui (MystenLabs#1428)
Browse files Browse the repository at this point in the history
* Update install.md

Add new Move Analyzer cargo install command directly to Install Sui

* Update install.md

Add dollar signs to all commands

* Update install.md

Note marketplace breakage
  • Loading branch information
Clay-Mysten authored Apr 19, 2022
1 parent 68849b4 commit 22f6900
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions doc/src/build/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ version 1.59.0 or higher in order to build and install Sui on your machine.
To develop in Sui, you will need the Sui binaries. After installing `cargo`, run:

```shell
cargo install --git https://github.com/MystenLabs/sui.git
$ cargo install --git https://github.com/MystenLabs/sui.git
```

This will put three binaries in your `PATH` (ex. under `~/.cargo/bin`) that provide these command line interfaces (CLIs):
Expand All @@ -28,15 +28,23 @@ $ echo $PATH

And ensure the `.cargo/bin` directory appears.

## IDE
For Move development, we recommend the [Visual Studio Code (vscode)](https://code.visualstudio.com/) IDE with the [Move Analyzer](https://marketplace.visualstudio.com/items?itemName=move.move-analyzer) plugin. See more [IDE options](https://github.com/MystenLabs/awesome-move#ides) in the [Awesome Move](https://github.com/MystenLabs/awesome-move) docs.
## Integrated Development Environment
For Move development, we recommend the [Visual Studio Code (vscode)](https://code.visualstudio.com/) IDE with the Move Analyzer language server plugin installed:

```shell
$ cargo install --git https://github.com/diem/move move-analyzer
```

Then follow the Visual Studio Marketplace instructions to install the [Move Analyzer extension](https://marketplace.visualstudio.com/items?itemName=move.move-analyzer). (The `cargo install` command for the language server is broken there; hence, we include the correct command above.)

See more [IDE options](https://github.com/MystenLabs/awesome-move#ides) in the [Awesome Move](https://github.com/MystenLabs/awesome-move) docs.

## Source code

If you need to download and understand the Sui source code, clone the Sui repository:

```shell
git clone https://github.com/MystenLabs/sui.git
$ git clone https://github.com/MystenLabs/sui.git
```

You can start exploring Sui's source code by looking into the following primary directories:
Expand Down

0 comments on commit 22f6900

Please sign in to comment.