Aire-One
/
calculon
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add(README) update

This commit is contained in:
Aire-One 2022-01-30 21:22:55 +01:00
parent f9d66eadb4
commit 1e9435c03b
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,9 +1,20 @@
# Calculon
My try to build a library with Luarocks using Teal!
A basic math library to package Teal project with LuaRocks.
Calculon is a simple library written with the Teal language that is packaged with LuaRocks.
The `consumer-project` is another LuaRocks project using Teal that tries to use the Calculon library.
![Calculon](doc/Calculon.webp "Calculon")
# TODO
* ~~The consumer works only because the generated file can find the module thanks to `./lua` that includes paths to locally installed packages~~ → is it really an issue?
* ~~Distribute teal files in the rock~~ → I think the rock should be Lua only (+ types definition for teal optionally)
* To not commit generated Lua files, the calculon module can have a `generate-rock` script that build and package the module (Can be done from a CI/CD like GitHub Actions 💡)
* The type definition trick works by abusing Luarocks specs, this needs to me standardized
# Logbook
## e18f54c977 init
@ -70,13 +81,6 @@ The consumer module doesn't need any trick thanks to the type definition file be
Note : We need to include the `lua_modules/share/lua/5.4` path to the tlconfig for this to work
# TODO
* ~~The consumer works only because the generated file can find the module thanks to `./lua` that includes paths to locally installed packages~~ → is it really an issue?
* ~~Distribute teal files in the rock~~ → I think the rock should be Lua only (+ types definition for teal optionally)
* To not commit generated Lua files, the calculon module can have a `generate-rock` script that build and package the module (Can be done from a CI/CD like GitHub Actions 💡)
* The type definition trick works by abusing Luarocks specs, this needs to me standardized
# References
* https://github.com/teal-language/tl/blob/master/docs/tutorial.md