Skip to content

Commit b7d01e5

Browse files
committed
Update README
1 parent 7f05c0b commit b7d01e5

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Bash IDE
22

3-
Bash language server. Uses [Tree Sitter][tree-sitter] and its
4-
[grammar for Bash][tree-sitter-bash].
3+
Bash language support for Atom-IDE. It's backed by
4+
[mads-hartmann/bash-language-server][bash-lsp].
55

66
## System Requirements
77

@@ -22,5 +22,29 @@ npm i -g bash-language-server
2222
- [x] Simple diagnostics reporting
2323
- [ ] Rename symbol
2424

25-
[tree-sitter]: https://github.com/tree-sitter/tree-sitter
26-
[tree-sitter-bash]: https://github.com/tree-sitter/tree-sitter-bash
25+
## Development Guide
26+
27+
Most of the interesting bits are happening in the server so you'll probably want
28+
to head over to the [development guide][server-dev-guide] to see the development
29+
flow for the server.
30+
31+
If not, here's how to work on the Atom client.
32+
33+
```bash
34+
git clone git@github.com:mads-hartmann/ide-bash && cd ide-bash
35+
npm install
36+
apm link
37+
```
38+
39+
If you want to inspect the communication between the Atom and the Bash language
40+
server then open the Developer Tools in Atom and execute the following piece of
41+
code in the Console.
42+
43+
```javascript
44+
atom.config.set('core.debugLSP', false)
45+
```
46+
47+
Reload the window and you should see all the messages.
48+
49+
[bash-lsp]: https://github.com/mads-hartmann/bash-language-server
50+
[server-dev-guide]: https://github.com/mads-hartmann/bash-language-server/blob/master/docs/development-guide.md

0 commit comments

Comments
 (0)