Skip to content

Commit e8f3d3e

Browse files
committed
Update root docs
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
1 parent 9de6a2a commit e8f3d3e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/lua.zig

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77
//!
88
//! ## Quick Start
99
//!
10+
//! To get started, a new `Lua` object must be created. The `Lua` struct provides a
11+
//! high-level API to Luau functionality.
12+
//!
13+
//! For convenience, `Lua` offers an `eval` function to convert Lua source code to
14+
//! Luau bytecode and execute it immediately. However, this compilation step should
15+
//! ideally be taken offline as it's resource-consuming.
16+
//!
1017
//! ```zig
1118
//! const std = @import("std");
1219
//! const luaz = @import("luaz");

0 commit comments

Comments
 (0)