Skip to content

Commit 064cac0

Browse files
committed
Update README.md to enhance clarity and provide usage instructions for the extension
1 parent aaf2ee4 commit 064cac0

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,23 @@ Before loading the extension, you need to add options to vscode user settings, a
3737
}
3838
```
3939

40+
41+
to try out, after cloning the project, run `sbt open` to open a debugging instance of VSCode with the extension loaded. Then the features like auto completion is ready to use.
42+
4043
## Project Structure
41-
The project is divided into two main parts: the core module and the VSCode extension module under /src/main/scala/functorcoder and /src/main/scala/vscextension respectively.
44+
The project is divided into **two main parts**: the core module and the VSCode extension module under /src/main/scala/functorcoder and /src/main/scala/vscextension respectively.
4245

43-
**To get started**, read the file `extensionMain.scala` in the VSCode extension module. It is the main entry point for the extension.
46+
To get started, start with `extensionMain.scala`, the main entry point for the extension.
4447

45-
The first part is the core module, we aim keeping it concise. It contains the main logic of the ai coding assistant:
48+
The first part is the core module, the main logic of the ai coding assistant:
4649
- Large Language Model (LLM) integration
4750
- sending propmt to LLM and getting the response
4851

49-
The second part is the VSCode extension module, which integrates the core module with the VSCode editor. It contains:
52+
The second part is the VSCode extension module, which integrates the core module with the VSCode editor:
5053
- commands: commands to be executed in the editor
5154
- code actions: quick fix actions
5255
- code completion: auto completion
5356
- editor ui: status bar, notifications, etc.
54-
55-
It's adopted from the [vscode-scalajs-hello](https://github.com/doofin/vscode-scalajs-hello) project. Refer to it for getting started with the VSCode extension development in Scala.js.
5657

5758

5859
project file structure for the core module:

0 commit comments

Comments
 (0)