From 9a95f9bef6cb22477c6e2fbc3f27a4e718a67fd8 Mon Sep 17 00:00:00 2001 From: Robin Haberkorn Date: Tue, 21 May 2024 00:36:01 +0300 Subject: [PATCH] nightly builds: normalized the artefact file names and updated README --- .github/workflows/nightly.yml | 11 ++++++++--- README.md | 14 ++++++++------ 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index d9e96f7..b552324 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -15,6 +15,10 @@ jobs: - name: Update Repositories run: sudo apt-get update + - name: Install Build Dependencies + run: | + # NOTE: The version from LuaRocks is just as old. + sudo apt-get install -y rename lua-ldoc make - name: Build AppImage run: | @@ -22,18 +26,19 @@ jobs: "https://github.com/AppImageCommunity/pkg2appimage/releases/download/continuous/pkg2appimage--x86_64.AppImage" chmod +x pkg2appimage.AppImage ./pkg2appimage.AppImage AppImage.yml - chmod a+x out/*.AppImage + cd out + rename 's/.*\.glibc/Applause-nightly-glibc/' *.AppImage + chmod a+x *.AppImage - name: Archive AppImage uses: pyTooling/Actions/releaser@v1.0.5 with: token: ${{ secrets.GITHUB_TOKEN }} tag: nightly + rm: true files: out/*.AppImage - name: Build Lua Documentation run: | - # NOTE: The version from LuaRocks is just as old. - sudo apt-get install -y lua-ldoc make make doc - name: Publish Website run: | diff --git a/README.md b/README.md index 2cddb01..bff510a 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ +[![Nightly Builds](https://github.com/rhaberkorn/applause2/actions/workflows/nightly.yml/badge.svg)](https://github.com/rhaberkorn/applause2/releases/tag/nightly) + # Applause ## Installation The easiest way to install Applause on Linux is to install a -prebuilt AppImage. -It should run on any x86_64 Linux system that has the jackd2 daemon -installed and running. +prebuilt [AppImage](https://appimage.org/) from a [nightly build](https://github.com/rhaberkorn/applause2/releases/tag/nightly). +It should run on any x86_64 Linux system that has the [JACK](https://jackaudio.org/) +daemon (jackd2/jackdmp) installed and running. The AppImage supports all three modes of running Applause: -1. `./Applause.AppImage` by default launches a Jupyter notebook on HTTP port 8888. +1. `./Applause-nightly-glibc2.29-x86_64.AppImage` by default launches a Jupyter notebook on HTTP port 8888. Additional parameters are passed to jupyter. Use the `APPLAUSE_OPTS` environment variable to pass commandline parameters to Applause itself. -2. `./Applause.AppImage ilua` launches a Jupyter/ILua console in the terminal. +2. `./Applause-nightly-glibc2.29-x86_64.AppImage ilua` launches a Jupyter/ILua console in the terminal. Additional parameters are passed to ILua. Use the `APPLAUSE_OPTS` environment variable to pass commandline parameters to Applause itself. -3. `./Applause.AppImage cli` launches a plain Applause shell (Lua prompt). +3. `./Applause-nightly-glibc2.29-x86_64.AppImage cli` launches a plain Applause shell (Lua prompt). Additional parameters are directly passed to Applause, but the `APPLAUSE_OPTS` environment variable can also provide parameters. This also mode also allows executing scripts, but currently you will have to pass absolute paths.