barectf
Note
|
This README mostly documents barectf development. To learn how to use barectf, read its documentation. |
Install barectf
See the barectf documentation’s Install barectf page.
Build barectf
barectf is a Poetry project.
To build barectf from this repository:
-
Build the project:
$ poetry build
The
dist
directory contains the distribution archives.
Build the barectf documentation
This repository contains an
Antora
documentation component version under the docs
directory.
This component version is the source of the barectf documentation website.
You can refer to this component version in your Antora playbook file, for example:
site:
# ...
content:
sources:
- url: https://github.com/efficios/barectf
branches: [stable-3.1]
start_path: docs
# ...
ui:
# ...
Test barectf
To run the barectf tests:
-
Make sure you have the testing requirements:
-
Run the tests:
$ tox
Get help
See the barectf documentation’s Get help page.