Skip to content

Commit 98afaa2

Browse files
committed
Update readme
1 parent 6a09993 commit 98afaa2

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ It does this by running the `rojo sourcemap` command, hence the Rojo executable
1313
(Note: `rojo sourcemap` is currently not released, you must manually install latest Rojo directly using `cargo install rojo --git https://github.com/rojo-rbx/rojo.git` to have sourcemap generation support).
1414
It is recommend to `.gitignore` the `sourcemap.json` file. In future, the language server will generate the file internally.
1515

16+
Note that currently the language server only supports generating a sourcemap from a `default.project.json`. If other project files are necessary, please open an issue.
17+
1618
The extension will also automatically populate the latest API types and documentation.
1719

1820
## Design Goals
@@ -23,6 +25,8 @@ Module resolution and typing will initially revolve around [Rojo](https://github
2325
The idea is to ensure module resolution is customisable, allowing the server to later be easily extended to support other environments where Luau may be used.
2426
We could also potentially take it a step forward, allowing the server to be used on an Lua 5.1 codebase through a translation layer (such as type comments through EmmyLua), allowing the language server to support general purpose Lua development powered by the Luau type inference engine.
2527

28+
If you use Luau in a different environment and are interested in using the language server, please get in touch!
29+
2630
## Supported Features
2731

2832
- [x] Rojo Files Resolution

0 commit comments

Comments
 (0)