From 78e137d0331901f8ab45fd646681d4b3c8e54104 Mon Sep 17 00:00:00 2001 From: CPunch Date: Thu, 11 Aug 2022 16:56:42 -0500 Subject: [PATCH] updated README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index afdc090..f1819d8 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ An experimental Lua 5.1 dump decompiler (typically dumped using `luac -o `). +You will quickly find that only **extremely** simple scripts are decompiled successfully right now. This is an experimental project and not all opcodes are properly handled for now. If you need a real decompiler I would recommend any of the handful of ones that exist already. + +## Why? + +Lua has a relatively small instruction set (only 38 different opcodes!). This makes it pretty feasible for a weekend decompiler project. (real) Decompilers are extremely complex pieces of software, so being able to write a simpler one helps show the theory without *much* of the headache. + ## Example usage ```sh