Skip to content

Commit 3ec0766

Browse files
committed
Add FAQ
1 parent 95adf8d commit 3ec0766

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

Diff for: FAQ.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# mlua FAQ
2+
3+
This file is for general questions that don't fit into the README or crate docs.
4+
5+
## Loading a C module fails with error `undefined symbol: lua_xxx`. How to fix?
6+
7+
Add the following rustflags to your [.cargo/config](http://doc.crates.io/config.html) in order to properly export Lua symbols:
8+
9+
```toml
10+
[target.x86_64-unknown-linux-gnu]
11+
rustflags = ["-C", "link-args=-rdynamic"]
12+
13+
[target.x86_64-apple-darwin]
14+
rustflags = ["-C", "link-args=-rdynamic"]
15+
```
16+
17+
## I want to add support for a Lua VM fork to mlua. Do you accept pull requests?
18+
19+
Adding new feature flag to support a Lua VM fork is a major step that requires huge effort to maintain it.
20+
Regular updates, testing, checking compatibility, etc.
21+
That's why I don't plan to support new Lua VM forks or other languages in mlua.

Diff for: README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@
1111
[codecov.io]: https://codecov.io/gh/khvzak/mlua
1212
[MSRV]: https://img.shields.io/badge/rust-1.56+-brightgreen.svg?&logo=rust
1313

14-
[Guided Tour](examples/guided_tour.rs)
14+
[Guided Tour] | [Benchmarks] | [FAQ]
15+
16+
[Guided Tour]: examples/guided_tour.rs
17+
[Benchmarks]: https://github.com/khvzak/script-bench-rs
18+
[FAQ]: FAQ.md
1519

1620
`mlua` is bindings to [Lua](https://www.lua.org) programming language for Rust with a goal to provide
1721
_safe_ (as far as it's possible), high level, easy to use, practical and flexible API.

0 commit comments

Comments
 (0)