Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 540 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 540 Bytes

Contributing to Jollyson

Setting up Jollyson for development

To set up Jollyson for development, you need Bash and Shellcheck installed on your system.

Generating the man page

To generate the man page, run:

sphinx-build -aqEW -b man doc/sphinx build/man

Note: This requires the myst-parser and sphinx Python packages to be installed.

To open the generated man page, run:

man build/man/jollyson.1

Running the linter

To execute the linter, run:

shellcheck bin/* libexec/*.bash