Skip to content

Commit c70ade7

Browse files
authored
Closes #3 include lua language server in readme
1 parent ab43299 commit c70ade7

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,21 @@
33
[![GitHub Tests Action](https://github.com/luttje/glua-api-snippets/actions/workflows/tests.yml/badge.svg)](https://github.com/luttje/glua-api-snippets/actions/workflows/tests.yml)
44
[![Test Coverage Status](https://coveralls.io/repos/github/luttje/glua-api-snippets/badge.svg?branch=main)](https://coveralls.io/github/luttje/glua-api-snippets?branch=main)
55

6-
This repository scrapes the Garry's Mod Lua API and generates snippets that will help EmmyLua provide autocompletion in VSCode and IntelliJ.
6+
This repository scrapes the Garry's Mod Lua API and generates snippets that will help provide autocompletion for Lua in editors like VSCode, IntelliJ and more.
77

88
## 🔨 Usage
99

1010
*In the following instructions we'll use `myproject` as an example name of the project we're working on.*
1111

12-
1. Install the EmmyLua extension for your editor of choice <small>*([EmmyLua VSCode Extension](https://marketplace.visualstudio.com/items?itemName=tangzx.emmylua) | [EmmyLua IntelliJ Plugin](https://plugins.jetbrains.com/plugin/9768-emmylua))*</small>
12+
1. Install one of these extensions for your editor of choice:
13+
* **Lua Language Server:** [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) | [NeoVim Configuration](https://github.com/LuaLS/lua-language-server#neovim)
14+
* **EmmyLua:** [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=tangzx.emmylua) | [IntelliJ Plugin](https://plugins.jetbrains.com/plugin/9768-emmylua)
1315

1416
2. Download the latest Lua release named something like `YYYY-MM-DD_HH-MM-SS.lua.zip` from [🔗 the releases page](https://github.com/luttje/glua-api-snippets/releases).
1517

1618
3. Extract the downloaded release to a directory on your computer. We'll use `~/glua-api-snippets` as an example.
1719

18-
4. EmmyLua needs to be able to find the snippets in your project workspace. You can either:
20+
4. The Language Server needs to be able to find the snippets in your project workspace. You can either:
1921

2022
<details>
2123
<summary>Add the directory to your editor workspace.</summary>
@@ -77,4 +79,4 @@ This project uses [Jest](https://jestjs.io/) to automate testing. You can run th
7779

7880
### API as JSON
7981

80-
The API is also available as JSON. You can find it with the Lua API package [on the releases page](https://github.com/luttje/glua-api-snippets/releases). It is named something like `YYYY-MM-DD_HH-MM-SS.json.zip`.
82+
The API is also available as JSON. You can find it with the Lua API package [on the releases page](https://github.com/luttje/glua-api-snippets/releases). It is named something like `YYYY-MM-DD_HH-MM-SS.json.zip`.

0 commit comments

Comments
 (0)