Yessiest
/
luaqalculator
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add 'README.md'

This commit is contained in:
Yessiest 2022-04-10 10:42:12 +00:00
parent 979f5959d2
commit c17b34200e
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# luaqalculator
This library implmenets some glue between libqalculate and lua, which is used for my bot's calculate function.
Calling this library a "binding" would probably be a mistake seeing that it simply isn't a binding, but rather a thing library that allows calling the "CalculateAndPrint" function from lua.
That being said, it's more than enough for my particular use case.
# Building
To make everything to compile with as few steps as possible you will need `make`, `g++`, `libqalculate` and `lua5.2` (which is the default target).
Once you have all of the above, simply type `make` and it will produce the needed `libqalcaulator.so` library.
If you wish to compile against a different version, simply change the variable `LUA_VERSION` in the makefile to the one you need.
# Usage
```lua
qalc = require("libqalculator")
print(qalc.qalc("sin(3 rad)")) -- Approximate mode (will return an interval with approximate values)
print(qalc.qalc("sin(3 rad)", true)) -- Exact mode (will return "sin(3 rad)" to avoid approximation)
```
# License
This project is licensed under the MIT license (located in the `LICENSE` file)