From 315829c8a14e6cd980c33130e8fab6c70343d4ec Mon Sep 17 00:00:00 2001 From: kaklakariada Date: Sun, 22 Sep 2024 13:48:59 +0200 Subject: [PATCH] Add note to readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 4add454..bcd781c 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,14 @@ An experimental Java library for embedding a Lua VM. [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava) +This project allows executing Lua scripts from a Java application. It uses [Foreign Function & Memory API (JEP 454)](https://openjdk.org/jeps/454) for accessing the Lua C API. + ## Development +### Native Interface + +Build scripts generate native interface classes in `build/generated/sources/jextract` using [Jextract](https://github.com/openjdk/jextract). Scripts download and cache Jextract automatically during the build. + ### Check for Dependency Updates ```sh