Skip to content

Commit

Permalink
Added own readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Wohlstand committed Dec 15, 2022
1 parent 58ddc3c commit 113eb1d
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# LuaJIT + CMake & UTF8-paths-on-Windows
There is the modified version of LuaJIT that has the next difference from the original version:
* In addition to its default GNU Make-based build, there is a CMake-based build was added
* Enforces the UTF-8 charset for file system-related functions to ensure the equal result on all supported platforms (without this addition, locale-depending ANSI charsets used on Windows) (You should specify the `-DLUAJIT_FORCE_UTF8_FOPEN=ON` CMake option to enable this feature)

If you find a bug using CMake build, please **DON'T REPORT IT TO OFFICIAL LuaJIT developers**, as they refuse to take the CMake building system support. So, you MUST verify the [latest original version](https://github.com/LuaJIT/LuaJIT) using the GNU Make-based building system to ensure that the same bug gets reproduced too:
* If the bug gets reproduced at both CMake and GNU-Make-based builds, feel free to report the bug to [official LuaJIT developers](https://github.com/LuaJIT/LuaJIT/issues).
* If the bug gets reproduced at the CMake-based build only, however, doesn't reproduce at the official GNU-Make-based build, you [should report this bug to me](https://github.com/WohlSoft/LuaJIT/issues).

# Original readme
## README for LuaJIT 2.1.0-beta3
LuaJIT is a Just-In-Time (JIT) compiler for the Lua programming language.

Project Homepage: https://luajit.org/

LuaJIT is Copyright (C) 2005-2022 Mike Pall.
LuaJIT is free software, released under the MIT license.
See full Copyright Notice in the COPYRIGHT file or in luajit.h.

Documentation for LuaJIT is available in HTML format.
Please point your favorite browser to:

doc/luajit.html

0 comments on commit 113eb1d

Please sign in to comment.