From 93659a03d67a890a11f344df37ea0ed9d700ef69 Mon Sep 17 00:00:00 2001 From: Marc Jakobi Date: Fri, 30 Apr 2021 12:26:46 +0000 Subject: [PATCH 1/3] Add usage instructions to README. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index b8879c0..24da016 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,25 @@ To run tests: ``` go test -v ./... ``` +## Usage + +To run the Arduino Language Server you need: + +- [arduino-cli](https://github.com/arduino/arduino-cli) + +After building, call: + +``` +./arduino-language-server -cli-config +``` +For example: +``` +./arduino-language-server -cli-config $HOME/.arduino15/arduino-cli.yaml +``` +Note: If you do not have an ArduinoCLI config file, you can create one by running: +``` +arduino-cli config init +``` ## Donations From 2f5fbcfe00523f09a6c7d8a0fd05e0bfd271e81a Mon Sep 17 00:00:00 2001 From: Marc Jakobi Date: Fri, 30 Apr 2021 21:04:09 +0700 Subject: [PATCH 2/3] Update README.md Co-authored-by: per1234 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 24da016..e964599 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ go test -v ./... To run the Arduino Language Server you need: -- [arduino-cli](https://github.com/arduino/arduino-cli) +- [Arduino CLI](https://github.com/arduino/arduino-cli) After building, call: From 7e3977305e1dc58aa7f141bd9cdbe175914a3bcb Mon Sep 17 00:00:00 2001 From: Marc Jakobi Date: Fri, 30 Apr 2021 21:04:16 +0700 Subject: [PATCH 3/3] Update README.md Co-authored-by: per1234 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e964599..473a0e7 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ For example: ``` ./arduino-language-server -cli-config $HOME/.arduino15/arduino-cli.yaml ``` -Note: If you do not have an ArduinoCLI config file, you can create one by running: +Note: If you do not have an Arduino CLI config file, you can create one by running: ``` arduino-cli config init ```