docs: cleanup: Rephrase and correct typos

[barectf.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index 32999b48043421a5560ad5a4a69ddca9c204a2a7..9c2abff81131dc153968edb6910a5df98c9a6ed2 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -5,18 +5,18 @@ ifndef::env-github[]
 endif::env-github[]
 
 = barectf
-25 September 2020
+8 March 2022
 Philippe Proulx
 
 image::https://barectf.org/barectf-logo.svg[{nbsp}]
 
 https://pypi.python.org/pypi/barectf[image:https://img.shields.io/pypi/v/barectf.svg[]]
-https://ci.lttng.org/job/barectf_master_build[image:https://img.shields.io/jenkins/s/https/ci.lttng.org/barectf_master_build.svg[]]
+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[]]
 
 [.lead]
 https://barectf.org/[**_barectf_**] (from _bare_ metal and _CTF_)
 is a generator of
-https://en.wikipedia.org/wiki/Tracing_(software)[tracer] which produces
+https://en.wikipedia.org/wiki/Tracing_(software)[tracers] that produce
 https://diamon.org/ctf/[CTF] data streams.
 
 [NOTE]
@@ -24,13 +24,13 @@ https://diamon.org/ctf/[CTF] data streams.
 This README mostly documents barectf development.
 
 To learn how to use barectf, read its
-https://barectf.org/docs/barectf/[documentation].
+https://barectf.org/docs/[documentation].
 ====
 
 == Install barectf
 
 See the barectf documentation's
-https://barectf.org/docs/barectf/3.0/install.html[Install barectf]
+https://barectf.org/docs/barectf/3.1/install.html[Install barectf]
 page.
 
 == Build barectf
@@ -52,14 +52,14 @@ The `dist` directory contains the distribution archives.
 == Build the barectf documentation
 
 This repository contains an
-https://docs.antora.org/antora/2.3/component-version/[Antora
+https://docs.antora.org/antora/latest/component-version/[Antora
 documentation component version] under the `docs` directory.
 
 This component version is the source of the
 https://barectf.org/docs/[barectf documentation website].
 
 You can refer to this component version in your
-https://docs.antora.org/antora/2.3/playbook/[Antora playbook file],
+https://docs.antora.org/antora/latest/playbook/[Antora playbook file],
 for example:
 
 [source,yaml]
@@ -69,7 +69,7 @@ site:
 content:
   sources:
     - url: https://github.com/efficios/barectf
-      branches: [stable-3.0]
+      branches: [stable-3.1]
       start_path: docs
     # ...
 ui:
@@ -86,7 +86,7 @@ To run the barectf tests:
 YAML configuration files of tracing tests use a little-endian
 native byte order.
 
-** https://tox.readthedocs.io/en/latest/install.html[tox]
+** https://tox.wiki/en/latest/installation.html[tox]
 ** A C{nbsp}compiler.
 +
 If your C{nbsp}compiler is not the command `cc`, then set the `CC`
@@ -104,5 +104,4 @@ $ tox
 == Get help
 
 See the barectf documentation's
-https://barectf.org/docs/barectf/3.0/get-help.html[Get help]
-page.
+https://barectf.org/docs/barectf/3.1/get-help.html[Get help] page.