gitback/ziglua
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add more details on API wrapper

Browse Source
This commit is contained in:
Nathan Craddock 2022-06-06 09:20:15 -06:00
parent 5fa582d886
commit f619696f3c
No known key found for this signature in database
GPG Key ID: ABE41A31B52E9DA7
2 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs.md
View File

@ -10,6 +10,16 @@ This documentation provides
* API Differences
* Example code
## Moving from the C API to Zig
While efforts have been made to keep the ziglua API similar to the C API, many changes have been made including:
* Renaming or omitting functions
* Modifying parameters (names and types) and return values
* Additional helper functions have been added
With this in mind, here are some general guidelines to help guide when moving from the C to Zig APIs
## Build Documentation
When integrating ziglua into your projects, the following three statements are required:

7
readme.md
View File

@ -2,6 +2,11 @@
A Zig library that provides a lightweight wrapper around the [Lua C API](https://www.lua.org/manual/5.4/manual.html#4) to embed the Lua virtual machine into your Zig programs. Currently tracks the latest Lua version (5.4.4).
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.
* [Docs](https://github.com/natecraddock/ziglua/blob/master/docs.md)
* [Examples](https://github.com/natecraddock/ziglua/blob/master/docs.md#examples)
## Why use ziglua?
In a nutshell, ziglua is a simple wrapper around the C API you would get by using `@cImport()` to bind Lua. ziglua aims to mirror the [Lua C API](https://www.lua.org/manual/5.4/manual.html#4) as closely as possible, while improving ergonomics using Zig's features. For example:
@ -12,7 +17,7 @@ In a nutshell, ziglua is a simple wrapper around the C API you would get by usin
* Compiler-enforced checking of optional pointers
* Functions return `bool` rather than `int` to indicate success
While there are a few helper functions added to complement the C API, ziglua aims to remain low-level. If you want something higher-level, perhaps try [zoltan](https://github.com/ranciere/zoltan).
While there are some helper functions added to complement the C API, ziglua aims to remain low-level. If you want something higher-level, perhaps try [zoltan](https://github.com/ranciere/zoltan).
## Getting Started