Skip to content

Commit e8a26b0

Browse files
committed
docs: mention comptime convenience functions in readme
1 parent b5dbf5d commit e8a26b0

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

readme.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Ziglua can be used in two ways, either
1010

1111
In both cases, Ziglua will compile Lua from source and link against your Zig code making it easy to create software that integrates with Lua without requiring any system Lua libraries.
1212

13-
Like the Lua C API, the Ziglua API "emphasizes flexibility and simplicity... common tasks may involve several API calls. This may be boring, but it gives us full control over all the details" (_Programming In Lua 4th Edition_). However, Ziglua takes advantage of Zig's features to make it easier and safer to interact with the Lua API.
14-
1513
## Documentation
1614
Docs are a work in progress and are automatically generated for each push to main. Most functions and public declarations are documented:
1715
* [Ziglua Docs](https://natecraddock.github.io/ziglua/#ziglua.lib.Lua)
@@ -30,8 +28,9 @@ In a nutshell, Ziglua is a simple wrapper around the C API you would get by usin
3028
* Type-checked enums for parameters and return values
3129
* Compiler-enforced checking of optional pointers
3230
* Better types in many cases (e.g. `bool` instead of `int`)
31+
* Comptime convenience functions to make binding creation easier
3332

34-
While there are some helper functions added to complement the C API, Ziglua aims to remain low-level. This allows full access to the Lua API through a layer of Zig's improvements over C.
33+
Nearly every function in the C API is exposed in Ziglua. Additional convenience functions like `toAny` and `pushAny` use comptime reflection to make the API easier to use.
3534

3635
## Integrating Ziglua in your project
3736

0 commit comments

Comments
 (0)