From 5eaa76b22d865820b3fb64c01bf70535b53c9d4d Mon Sep 17 00:00:00 2001 From: Jonathan Worthington Date: Tue, 6 Jan 2026 16:20:00 +0100 Subject: [PATCH] Provide some more dev setup documentation This fills in some of the gaps in how to get a development environment in place and run the tests. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f1872e3d..a2a889c1 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,24 @@ Please see the [Agrammon website](https://www.agrammon.ch) for more details. ## Port to Raku -This is a port of the existing Agrammon web application to Raku. It will -be finished by Christmas. +This is a port of the existing Agrammon web application to Raku. It was +finished by Christmas. + +## Development setup + +You'll need to: + +1. Install `rakudo` and `zef` +2. Install the Raku dependencies: `zef install --deps-only .` +3. Install the Perl dependencies: `cpanm --installdeps .` +4. Install the `lualatex` program and Latex packages needed (`sudo apt install + texlive-luatex texlive-latex-extra texlive-fonts-recommended texlive-science`) ## Running tests +Run tests using `prove6 -l t/`. If missing `prove6`, you can install it with +`zef install App::Prove6`. + To only run unit tests, set `AGRAMMON_UNIT_TEST=1` in the environment. The integration tests currently have quite some setup dependencies; this should be addressed in the future.