docs: install instructions (72b29aa0) · Commits · to be continuous... / tools / tbc-check

README.md

+16 −7

Original line number	Diff line number	Diff line
		@@ -2,17 +2,13 @@

		`tbc-check` is a basic CLI program that checks to-be-continuous templates.

		## Usage
		## Install

		```bash
		# install dependencies
		poetry install
		pip install tbc-check --index-url https://gitlab.com/api/v4/projects/54325774/packages/pypi/simple --upgrade

		# obtain help
		poetry run tbc-check --help

		# run tool
		poetry run tbc-check path/to/tbc/template
		tbc-check --help
		```

		## Checked rules
		@@ -27,3 +23,16 @@ poetry run tbc-check path/to/tbc/template
		- the input/variable is documented in the README with same default (WARNING only)

		If any non-WARNING rule fails, `tbc-check` fails with exit code 127.

		## Developers

		```bash
		# install dependencies
		poetry install

		# obtain help
		poetry run tbc-check --help

		# run tool
		poetry run tbc-check path/to/tbc/template
		```