Skip to content

Provide some more dev setup documentation #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zaucker merged 1 commit into from
Jan 6, 2026
Merged

Provide some more dev setup documentation #619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading