From e2c8ca8a48c53104bf3b4cab1ef58b2060d5beba Mon Sep 17 00:00:00 2001 From: Jonathan Rajotte Date: Wed, 22 Nov 2017 17:47:01 -0500 Subject: [PATCH] Base readme Signed-off-by: Jonathan Rajotte --- README | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README b/README index 0964f8b..0f88f93 100644 --- a/README +++ b/README @@ -1,4 +1,21 @@ -Requirement: +LTTng inter-version compatibility test suite. +============================================ -Ubuntu: - libgit2-dev +This project aim to provide an inter-version compatibility test suite to +document, automate, validate behaviours of the LTTng projects between version +and prevent unexpected regression. + +This project is intended to run inside a Continuous Integration environment. +A running version will be made available on ci.lttng.org. + +A python3 virtual env is recommenced to run this test suite. + +The suite is currently run under a python 3.5.3 virtual environment situated at +the root of the current directly under .venv. + +The virtualenv can be configured with the provided requirement.txt + +The running environment should provide all dependencies required by +lttng-ust/lttng-tools/lttng-modules 2.7/2.8/2.9/2.10, babeltrace 1.3/1.4/1.5. + +Latest liburcu stable is also recommended. -- 2.34.1