Skip to content

Commit

Permalink
doc: adds some instruction to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
johnfking committed Sep 13, 2022
1 parent 57a42e3 commit cb19885
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
@@ -1,4 +1,16 @@
# Macroquest Lua Definitions Library
## Overview
## Examples
This is a set of Lua files, that when placed in a subdirectory under your Lua folder, provide code completion, method signature and brief contexual help, as well as the ability to check types as shown in the examples below.

## How to Use
- Annotate your Macroquest import as a type of "Mq" as shown. *Note:* This is case sensitive.
![image](https://user-images.githubusercontent.com/414568/189778453-5910f65d-2dee-45b9-a95e-faf24423c1ed.png)

- Watch the magic start. Once mq has been identified to the Language server, you will start to see the context menu's populate while coding.
![image](https://user-images.githubusercontent.com/414568/189778777-e386e385-2065-4d00-b3cd-780f3a1946b2.png)

## Installation
The files in this library work with the VSCode Extension found here:
- [VSCode Marketplace - Lua Language Server Extension](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
The extension can also be installed directly from within VSCode. Search Extensions for "Lua Language Server" as seen here, and install the one by "sumneko"
![image](https://user-images.githubusercontent.com/414568/189777359-887c937a-5453-4ea0-a8f0-5c41ea4d6b66.png)

0 comments on commit cb19885

Please sign in to comment.