modeco80
/
gmod-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
William Venner 2022-01-22 19:39:32 +00:00
parent 3e708a0c0d
commit 48f51fd444
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -8,4 +8,10 @@ A swiss army knife for creating binary modules for Garry's Mod in Rust.
# Examples
[Click here](https://github.com/WilliamVenner/gmod-rs/tree/master/examples/) to see examples.
[Click here](https://github.com/WilliamVenner/gmod-rs/tree/master/examples/) to see examples.
# Nightly requirement
Currently, this crate requires the Rust Nightly compiler to be used.
This is because of the nature of Rust <-> C FFI (which is used extensively in this crate for interfacing with Lua) and the undefined behaviour that occurs when Lua performs long jumps out of functions during errors, or when Rust panics and unwinds out of a foreign stack frame. The [`C-unwind` ABI](https://rust-lang.github.io/rfcs/2945-c-unwind-abi.html) is used to prevent this undefined behaviour.