1 // Render with Asciidoctor
11 image::https://barectf.org/barectf-logo.svg[{nbsp}]
13 https://pypi.python.org/pypi/barectf[image:https://img.shields.io/pypi/v/barectf.svg[]]
14 https://ci.lttng.org/view/barectf/job/barectf_master_linuxbuild/[image:https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.lttng.org%2Fview%2Fbarectf%2Fjob%2Fbarectf_master_linuxbuild%2F[]]
17 https://barectf.org/[**_barectf_**] (from _bare_ metal and _CTF_)
19 https://en.wikipedia.org/wiki/Tracing_(software)[tracers] that produce
20 https://diamon.org/ctf/[CTF] data streams.
24 This README mostly documents barectf development.
26 To learn how to use barectf, read its
27 https://barectf.org/docs/[documentation].
32 See the barectf documentation's
33 https://barectf.org/docs/barectf/3.1/install.html[Install barectf]
38 barectf is a https://python-poetry.org/[Poetry] project.
40 To build barectf from this repository:
42 . https://python-poetry.org/docs/#installation[Install Poetry].
50 The `dist` directory contains the distribution archives.
52 == Build the barectf documentation
54 This repository contains an
55 https://docs.antora.org/antora/latest/component-version/[Antora
56 documentation component version] under the `docs` directory.
58 This component version is the source of the
59 https://barectf.org/docs/[barectf documentation website].
61 You can refer to this component version in your
62 https://docs.antora.org/antora/latest/playbook/[Antora playbook file],
71 - url: https://github.com/efficios/barectf
72 branches: [stable-3.1]
81 To run the barectf tests:
83 . Make sure you have the testing requirements:
84 ** A little-endian architecture.
86 YAML configuration files of tracing tests use a little-endian
89 ** https://tox.wiki/en/latest/installation.html[tox]
92 If your C{nbsp}compiler is not the command `cc`, then set the `CC`
93 environment variable to your compiler's path and export it to run
96 ** https://www.gnu.org/software/make/[GNU Make]
106 See the barectf documentation's
107 https://barectf.org/docs/barectf/3.1/get-help.html[Get help] page.