Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
robinlzw committed Oct 19, 2023
1 parent 55a5155 commit b3f681d
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
17 changes: 13 additions & 4 deletions language/move-analyzer/editors/code/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# This a project modified from https://github.com/move-language/move
# Support
1. If you have any problem, please report
[a GitHub issue to the movebit/sui-move-analyzer-issue repository](https://github.com/movebit/sui-move-analyzer-issue) to get help.
2. Welcome to the developer discussion group as well:
https://t.me/moveanalyzer

# Sui-Move-Analyzer

Expand All @@ -17,7 +21,9 @@ The sui-move-analyzer Visual Studio Code extension works via two components: the
### 1. Installing the `sui-move-analyzer` language server<span id="Step1">

The `sui-move-analyzer` language server is a Rust program that is part of the
[Move repository](https://github.com/move-language/move). It may be installed in one of two ways:
[Move repository](https://github.com/move-language/move). Before installation, you need install [Sui Client CLI](https://docs.sui.io/build/install).

`sui-move-analyzer` may be installed in one of two ways:

* Use Cargo (Recommended)
Use Rust's package manager `cargo` to install `sui-move-analyzer` in your user's PATH. This
Expand Down Expand Up @@ -70,7 +76,9 @@ bottom-right of your Visual Studio Code screen when opening a Move file, it mean
`sui-move-analyzer.server.path` setting, and set it to the location of the `sui-move-analyzer` language
server you installed.
3. If the above steps don't work, then report
[a GitHub issue to the Move repository](https://github.com/move-language/move/issues) to get help.
[a GitHub issue to the movebit/sui-move-analyzer-issue repository](https://github.com/movebit/sui-move-analyzer-issue) to get help.
4. Welcome to the developer discussion group as well:
https://t.me/moveanalyzer

## Features

Expand All @@ -90,5 +98,6 @@ Move source file (a file with a `.move` file extension) and:
- go to type definition
- go to references
- type on hover
- sui commands line tool
- sui commands line tool(you need install Sui Client CLI locally)
- sui project template
- linter for move file
6 changes: 3 additions & 3 deletions language/move-analyzer/editors/code/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
"publisher": "MoveBit",
"icon": "images/move.png",
"license": "Apache-2.0",
"version": "1.0.0",
"version": "1.0.2",
"preview": true,
"homepage": "https://github.com/move-language/move",
"repository": {
"url": "https://github.com/move-language/move.git",
"type": "git"
},
"bugs": {
"url": "https://github.com/move-language/move/issues"
"url": "https://github.com/movebit/sui-move-analyzer-issue"
},
"engines": {
"vscode": "^1.67.1"
Expand Down Expand Up @@ -245,7 +245,7 @@
"scripts": {
"compile": "tsc -p ./ && cd ../../ && cargo build --bin sui-move-analyzer",
"watch": "tsc -watch -p ./",
"lint": "eslint . --ext ts --max-warnings 0",
"lint": "eslint . --ext ts --max-warnings 100",
"fix": "eslint . --ext ts --fix",
"copy-tests-files": "copyfiles \"tests/**/*.move\" \"tests/**/*.exp\" \"tests/**/*.toml\" \"tests/**/*.code-workspace\" out",
"pretest": "npm run compile && npm run lint && npm run copy-tests-files",
Expand Down
3 changes: 3 additions & 0 deletions language/move-analyzer/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b3f681d

Please sign in to comment.