Skip to content

Commit 4f215a7

Browse files
committed
Better readme
1 parent 966880c commit 4f215a7

File tree

2 files changed

+27
-45
lines changed

2 files changed

+27
-45
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,30 @@ For now, you have to clone the repo and run `npm run compile`. The language serv
1818
### Upcoming Features
1919
- Formatting of temporary files
2020
- Type diagnosis
21+
22+
## Develop
23+
24+
### Structure
25+
26+
```
27+
.
28+
├── client // Language Client
29+
│ ├── src
30+
│ │ └── extension.ts // Language Client entry point
31+
├── package.json // The extension manifest.
32+
└── server // Language Server
33+
└── src
34+
└── server.ts // Language Server entry point
35+
```
36+
37+
### Running the Project
38+
39+
- Run `npm install` in this folder. This installs all necessary npm modules in both the client and server folder
40+
- Open VS Code on this folder.
41+
- Press Ctrl+Shift+B to compile the client and server.
42+
- Switch to the Debug viewlet (command palette -> View: Show Run and Debug).
43+
- Select `Launch Client` from the drop down.
44+
- Run the launch config.
45+
- If you want to debug the server as well use the launch configuration `Attach to Server`
46+
- In the [Extension Development Host] instance of VSCode, open a document in 'plain text' language mode.
47+
- Try `ReScript` mode formatting with `.res` or `.resi` files.

doc.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

0 commit comments

Comments
 (0)