CONTRIBUTING.txt

Contribution to the Manual
--------------------------

- You need to compile the manual files with LuaLaTeX,
  because it is rather slow to compile them with XeLaTeX or PDFLaTeX.

- The manual `tabularray.tex` is splitted into subfiles and put in manual folder.
  You can compile each subfile and see the output.

- After editing subfiles in manual folder,
  you need to run `texlua manual.lua` to generate `tabularray.tex` from subfiles.

- Now you can create a pull request for your contribution.


Contribution to the Code
------------------------

- You need to install `l3build` package into your TeX distribution first.

- After edting the source code, run `l3build check` to compile test files.

- On Windows, run `texlua ppmcheck.lua` to compare MD5 checksums for test outputs.

- The project use `pdftoppm` program to convert PDF to PNG and make MD5 checksums.
  But unfortunately `pdftoppm` create PNG with different MD5 checksums on Linux.
  Therefore you can not do the previous step on Linux. Maybe someone can help.