From 48f51fd4446f548b0904d9b5d7146723d8f36937 Mon Sep 17 00:00:00 2001 From: William Venner Date: Sat, 22 Jan 2022 19:39:32 +0000 Subject: [PATCH] Update README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 99c4b63..5583774 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +[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. \ No newline at end of file