Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: adds some instruction to readme
- Loading branch information
Showing
1 changed file
with
13 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |