Skip to content

Commit 46b0574

Browse files
Merge pull request #26 from Chia-Network/EL.readme
Update README
2 parents d6f6fd6 + 6e2c02e commit 46b0574

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
# chialisp-lsp-client README
1+
# README
22

3-
A rust based chialisp language server client delivered with a rust client compiled
4-
to webassembly. The rust client uses much of the same code as chia's chialisp
5-
compiler, but tries to be more lenient and faster to use incrementally.
3+
A rust based Chialisp language server client delivered with a rust client compiled
4+
to webassembly (wasm). This extension uses the modern Chialisp compiler from `clvm_tool_rs` (https://github.com/Chia-Network/clvm_tools_rs).
5+
6+
To use as a Visual Studio Code extension, simply install the extension from the extension marketplace
7+
https://marketplace.visualstudio.com/items?itemName=ChiaNetwork.chialisp
68

79
## Features
810

911
- Highlighting functions, arguments
1012
- Go to definition (if in the same file)
1113
- Completion
1214
- Include files (when the filesystem is accessible)
13-
- Debug adapter
15+
- Debugging support via the Debug Adapter Protocol
1416

1517
## Requirements
1618

@@ -41,15 +43,13 @@ directories you'll be including other files from.
4143
"include_paths": ["/home/person/dev/chia-blockchain/chia/wallet/puzzles"]
4244
}
4345

44-
## Known Issues
45-
46-
Currently, the language server is in beta. There are no specific known bugs at this point, but we expect continued updates as bugs are encountered, leading up to a full release.
46+
## Manual Building Steps:
4747

48-
## Release Notes
48+
This is not required to use the extension, as it is available fully compiled and ready to use directly from the vscode extension marketplace. However, if you wish to make code changes or want to manually build this extension, you can follow the below steps:
4949

50-
### 0.0.1 (2022/09/28)
50+
npm install -g vsce
51+
cargo install wasm-pack
52+
rustup target add wasm32-unknown-unknown
5153

52-
- Public beta release
53-
- Includes syntax highlighting, go to definition, and auto-completion
5454

5555
---

0 commit comments

Comments
 (0)