Amend example usage to specify the Lua implementation flavor#39
Amend example usage to specify the Lua implementation flavor#39nurpax wants to merge 1 commit intonatecraddock:mainfrom
Conversation
|
I hadn't considered the library artifact name causing issues. I do think it is reasonable to rename it to Note that there actually are docs for how to specify the version. See the build documentation of docs.md here: https://github.com/natecraddock/ziglua/blob/main/docs.md#build-documentation But your PR does suggest that the documentation could be clearer, or maybe everything in docs.md could be moved to the readme? I'm not sure yet. I'll have limited access to a computer the next few days |
I can send a PR if you don't get to changing it first. I think it's better renamed so that the usage instructions are simpler.
I had completely missed these docs! (not the first time) I would be in favor of merging them with the main README.md. The links to API references could be kept, but maybe retitle to "Ziglua API reference [Lua 5.1]" or something similar?
Have a nice computer-less few days. :) I have everything running on my side, I'm just reporting what I find when things are fresh in my mind. |
|
With #43 merged, I don't believe anything in this PR is needed anymore. The library is still named "luau" internally, but with the new modules api, there isn't a need to use I also updated the readme. If you think the docs could be improved, or "luau" should be renamed to "lua" again, just let me know! |
|
Really cool stuff - I like these improvements (both in Ziglua and in Zig itself)! I read through the README and selecting Lua flavor is very clear now. |
Note: it'd be simpler if the lib artifact was named "lua" instead of "luau" like it is now.