diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..eb01818 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,21 @@ +# mlua FAQ + +This file is for general questions that don't fit into the README or crate docs. + +## Loading a C module fails with error `undefined symbol: lua_xxx`. How to fix? + +Add the following rustflags to your [.cargo/config](http://doc.crates.io/config.html) in order to properly export Lua symbols: + +```toml +[target.x86_64-unknown-linux-gnu] +rustflags = ["-C", "link-args=-rdynamic"] + +[target.x86_64-apple-darwin] +rustflags = ["-C", "link-args=-rdynamic"] +``` + +## I want to add support for a Lua VM fork to mlua. Do you accept pull requests? + +Adding new feature flag to support a Lua VM fork is a major step that requires huge effort to maintain it. +Regular updates, testing, checking compatibility, etc. +That's why I don't plan to support new Lua VM forks or other languages in mlua. diff --git a/README.md b/README.md index a0d9b43..211da8b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,11 @@ [codecov.io]: https://codecov.io/gh/khvzak/mlua [MSRV]: https://img.shields.io/badge/rust-1.56+-brightgreen.svg?&logo=rust -[Guided Tour](examples/guided_tour.rs) +[Guided Tour] | [Benchmarks] | [FAQ] + +[Guided Tour]: examples/guided_tour.rs +[Benchmarks]: https://github.com/khvzak/script-bench-rs +[FAQ]: FAQ.md `mlua` is bindings to [Lua](https://www.lua.org) programming language for Rust with a goal to provide _safe_ (as far as it's possible), high level, easy to use, practical and flexible API.