Skip to content

Commit 93659a0

Browse files
author
Marc Jakobi
committed
Add usage instructions to README.
1 parent 64a0e42 commit 93659a0

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

Diff for: README.md

+19
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,25 @@ To run tests:
6060
```
6161
go test -v ./...
6262
```
63+
## Usage
64+
65+
To run the Arduino Language Server you need:
66+
67+
- [arduino-cli](https://github.com/arduino/arduino-cli)
68+
69+
After building, call:
70+
71+
```
72+
./arduino-language-server -cli-config <path-to-cli-config>
73+
```
74+
For example:
75+
```
76+
./arduino-language-server -cli-config $HOME/.arduino15/arduino-cli.yaml
77+
```
78+
Note: If you do not have an ArduinoCLI config file, you can create one by running:
79+
```
80+
arduino-cli config init
81+
```
6382

6483
## Donations
6584

0 commit comments

Comments
 (0)