Skip to content

Commit

Permalink
nightly builds: normalized the artefact file names and updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
rhaberkorn committed May 20, 2024
1 parent c487e50 commit 9a95f9b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
11 changes: 8 additions & 3 deletions .github/workflows/nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,30 @@ 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: |
wget -O pkg2appimage.AppImage \
"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: |
Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 9a95f9b

Please sign in to comment.