From b8d2cbd015dbf78da90790f53a18b2995333ca2e Mon Sep 17 00:00:00 2001 From: Albert Graef Date: Sun, 8 Sep 2024 20:21:48 +0200 Subject: [PATCH] Update README. --- README | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/README b/README index dcbbd5f..9216d33 100644 --- a/README +++ b/README @@ -27,8 +27,8 @@ corresponding subdirectories). Originally written by Claude Heiland-Allen, pdlua has gone through the hands of a few people over the years, including mrpeach (maintainer since 2011), zmoelnig a.k.a. umlaeute (loader update, Debian package), and myself (Arch package, Lua 5.3+ support, Purr Data and -plugdata support, tutorial). Please also check my brief account on the history -of pd-lua below. +plugdata support, pdx.lua live-coding extension, tutorial). Please also check +my brief account on the history of pd-lua below. Lua 5.4 is highly recommended with the latest version, Lua 5.3 works as well. Reportedly, Lua 5.2 and even 5.1 still work (at least to some extent), @@ -85,19 +85,16 @@ on https://github.com/agraef/pd-lua (but see below for the Deken package). Also, both Purr Data and plugdata ship with pdlua, and have it enabled by default, so no 3rd party package is needed in those environments. -For vanilla, we recommend installing the Deken package (named `pdlua`), +For vanilla Pd, we recommend installing the Deken package (named `pdlua`), readily available using Pd's `Find externals` menu option. This package was originally uploaded by Alexandre Porres, but Ben Wesch recently added Deken tests and uploads to our GitHub workflow, so that the Deken releases are now automatized and always in sync with the GitHub releases. Thanks, Ben! -The latest release is also in the Arch repositories (maintained by dvzrv, -thanks David!), and in the Debian repositories (maintained by IOhannes -Zmölnig, thanks umlaeute!). - -To enable the pdlua loader in Pd after installation, just add `pdlua` to your -startup libraries (after adding its parent directory to Pd's search path if -necessary) and you should be set. +pd-lua is also in the Arch repositories (maintained by dvzrv, thanks David!), +and in the Debian repositories (maintained by IOhannes Zmölnig, thanks +umlaeute!). (During busy times, these may trail our releases for a little bit, +but most of the time they will the latest version.) Mac users please note that the packages I distribute aren't notarized, so on recent macOS versions you'll have to jump through the usual hoops to make them @@ -106,6 +103,21 @@ usually do the trick, but check the internet for up-to-date information on Gatekeeper for details. +Enabling pdlua: + +Again, this step is only necessary with vanilla Pd; both Purr Data and +plugdata have the pdlua loader enabled by default, so it should be ready to go +immediately. + +With vanilla Pd, after installing pdlua, the pdlua loader also needs to be +added to your startup libraries, before Pd will recognize any Lua object in +your patches. This only needs to be done once. (Alternatively, you can also +use the `-lib pdlua` option on the Pd command line, or a `declare -lib pdlua` +object in a patch with Lua objects.) To make any of this work, you may also +have to add the parent directory of the `pdlua` folder to Pd's search path if +pdlua was installed in an unusual location. + + Compilation Instructions: You can also compile pdlua yourself from source, which isn't hard to do.