luau-lang/luau
1
0
Fork 0
mirror of https://github.com/luau-lang/luau.git synced 2025-05-04 10:33:46 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: update readme installation guide

Browse source
This commit is contained in:
Brittany G 2022-12-27 15:10:57 -08:00
parent fb2f146123
commit cb9ff0dd27
1 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -17,12 +17,29 @@ Luau is an embeddable language, but it also comes with two command-line tools by
`luau-analyze` is a command-line type checker and linter; given a set of input files, it produces errors/warnings according to the file configuration, which can be customized by using `--!` comments in the files or [`.luaurc`](https://github.com/Roblox/luau/blob/master/rfcs/config-luaurc.md) files. For details please refer to [type checking]( https://luau-lang.org/typecheck) and [linting](https://luau-lang.org/lint) documentation.
You can download the binaries from [a recent release](https://github.com/Roblox/luau/releases).
# Installation
You can install and run Luau using the following methods:
1. Homebrew
2. Downloading compiled binaries
3. Building compiled binaries
Each method is detailed below, you only need to use one option. After installing, you will want to validate the installation was successful by running the test case [here](https://luau-lang.org/getting-started).
## Homebrew Installation
1. Install Homebrew following these instructions [here](https://docs.brew.sh/Installation).
2. Run this command: `brew install luau`. Homebrew will install the program for you.
## Compiled Binaries Installation
1. Download the binaries from [a recent release](https://github.com/Roblox/luau/releases).
2. On mac OS, move `luau` and `luau-analyze` files using this command `mv ../<insert filename here> /usr/local/bin/`.
# Building
## Build on Local Machine Installation
1. Depending on your system, you can compile the code using Option 1) `CMake` or Option 2) `make`
To build Luau tools or tests yourself, you can use CMake on all platforms:
Option 1: On all platforms, you can use CMake to run the following commands:
```sh
mkdir cmake && cd cmake
@ -31,13 +48,13 @@ cmake --build . --target Luau.Repl.CLI --config RelWithDebInfo
cmake --build . --target Luau.Analyze.CLI --config RelWithDebInfo
```
Alternatively, on Linux/macOS you can use make:
Option 2: Alternatively, on Linux/macOS you can use `make`:
```sh
make config=release luau luau-analyze
```
To integrate Luau into your CMake application projects, at the minimum you'll need to depend on `Luau.Compiler` and `Luau.VM` projects. From there you need to create a new Luau state (using Lua 5.x API such as `lua_newstate`), compile source to bytecode and load it into the VM like this:
2. To integrate Luau into your CMake application projects, at the minimum you'll need to depend on `Luau.Compiler` and `Luau.VM` projects. From there you need to create a new Luau state (using Lua 5.x API such as `lua_newstate`), compile source to bytecode and load it into the VM like this:
```cpp
// needs lua.h and luacode.h
@ -50,6 +67,7 @@ if (result == 0)
return 1; /* return chunk main function */
```
## Additional information about usage
For more details about the use of host API you currently need to consult [Lua 5.x API](https://www.lua.org/manual/5.1/manual.html#3). Luau closely tracks that API but has a few deviations, such as the need to compile source separately (which is important to be able to deploy VM without a compiler), or lack of `__gc` support (use `lua_newuserdatadtor` instead).
To gain advantage of many performance improvements it's highly recommended to use `safeenv` feature, which sandboxes individual scripts' global tables from each other as well as protects builtin libraries from monkey-patching. For this to work you need to call `luaL_sandbox` for the global state and `luaL_sandboxthread` for each new script's execution thread.