aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
AgeCommit message (Collapse)AuthorFilesLines
6 dayspoint to new home at https://git.fmsbw.de/applause2/Robin Haberkorn1-7/+5
This also replaces Github workflows with .fmsbw CI scripts.
2024-05-21README: added introduction and list of featuresRobin Haberkorn1-7/+35
2024-05-21nightly builds: normalized the artefact file names and updated READMERobin Haberkorn1-6/+8
2024-05-20AppImages contain Jupyter notebook support nowRobin Haberkorn1-8/+24
* that's their default mode, but the ILua console and Lua prompt can also be accessed by passing additional commandline parameters. * README: we can install our ILua fork without explicitly cloning the repository which simplifies matters a bit.
2024-05-20added AppImage via pkg2appimageRobin Haberkorn1-1/+1
* Docker turned out to be impractical since you cannot connect a dockerized Jack client to a Jack server on the host as library versions would have to match exactly. Neither did I get Netjack to run in Docker. Also when running in Docker, it would be tricky to get gnuplot to work (and Tcl/Tk support in the future). Especially the Jupyter notebook packaging would have been a lot easier, though with Docker. * AppImage will automatically avoid bundling libjack and require a compatible libjack on the host instead. * Using pkg2appimage ensures we can pull in dependencies as Debian packages. * This version of AppImage.yml does not contain Jupyter notebooks.
2024-05-01format tables in LDoc via HTML instead of MarkdownRobin Haberkorn1-1/+2
* this is unreliable but should be tested on the build server as well * drops the lua-discount dependency * updated TODO
2024-01-29updated README and TODORobin Haberkorn1-1/+1
2024-01-24README: mention some useful programsRobin Haberkorn1-3/+4
2024-01-22README: documented some FreeBSD tweaksRobin Haberkorn1-8/+30
2024-01-12minor FreeBSD compatibility fixes and documentationRobin Haberkorn1-1/+10
2023-12-10updated Jupyter notebook documentation after ILua forkingRobin Haberkorn1-18/+9
2023-11-16improved interruption (SIGINT, CTRL+C) supportRobin Haberkorn1-1/+9
* Just like the original LuaJIT interpreter, this will use a hook to automatically raise an error from Lua code. * Unfortunately, as long as Jit compilation is enabled, this cannot reliably work. Therefore we still set an `interrupted` flag that must be polled from tight loops. * Instead of polling via applause_push_sample() which gave interruption-support only to Stream:play(), we now have a separate checkint() function. * checkint() should be manually added to all tight loops. * Stream:foreach() and everthing based on it is now also supporting interruptions (via checkint()). * This internally works via applause_is_interrupted(). A C function was exposed only because LuaJIT does not support volatile-qualifiers and would optimize away reads to the interrupted-flag. As a side effect, we can also reset the hook. * Flags set in signal handlers should be `volatile`. * Added likely() and unlikely() macros to C code. * Updated sample.ipynb Jupyter notebook: Everything important is now supported, albeit requiring custom ILua patches.
2023-11-15Added Jupyter notebook exampleRobin Haberkorn1-4/+4
2023-11-15Jupyter integration improvements: support $APPLAUSE_OPTS and document how to ↵Robin Haberkorn1-10/+11
display graphics and rich text
2023-11-12documented how to run Applause in Jupyter Consoles and NotebooksRobin Haberkorn1-0/+62
* This is at the very least cool to have and will be worthwile to write about in the dissertation. * Added ilua-wrapper.sh script which can be used as the ILua interpreter and/or can be symlinked to `lua` in PATH, so ILua will pick up Applause even in Notebooks without any additional tweaks.
2023-11-12support running scripts in batch modeRobin Haberkorn1-0/+2
* This should be largely compatible with the standard Lua interpreter. The `arg` array is also initialized.
2023-09-15documentation updateRobin Haberkorn1-1/+3
2023-09-13added LDoc documentationRobin Haberkorn1-0/+11
* gives a useful overview of everything supported right now * especially the type documentation is useful, as these things are not self-evident in Lua (because of dynamic typing). * The LDoc page can later be published as the Github pages of the project. This can even be done automatically by a Github action. However, we should first make sure that it's okay to publish the project before defending the thesis since Github pages will always be public even for private repositories. * Documentation of command-line parameters is lacking (TODO). * It may be possible to use types like "Stream(number)" to describe streams of numbers. The LDoc documentation mentions boxed types. Perhaps there can even be Streamable(number)? * We are also lacking good example programs and/or introductory material.
2023-09-05added README and TODORobin Haberkorn1-0/+59