Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 895 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 895 Bytes

Contributing

This guide assumes that you have a working installation of lua and luarocks.

To get started, run the following command in the root directory of the project.

luarocks init
luarocks make
luarocks test --prepare

Running tests

luarocks make
luarocks test

This will run all tests and linters.

Pandoc filter

The source code for the pandoc filter can be found at src/filter.lua. This needs to be built before it can be used as a filter.

lua scripts/bundle.lua

This will build the filter in the build directory. See the examples for usage instructions.

Creating a new rockspec

luarocks new_version lua-igt-dev-1.rockspec "$VERSION" --tag "v$VERSION" --dir rockspecs