From 0488fcb69086c86054c2c2c878e3f7c51a0d8b44 Mon Sep 17 00:00:00 2001 From: Quim Motger Date: Mon, 30 Dec 2019 13:10:56 +0100 Subject: [PATCH] Update README with example info --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 217e23f..143fd2d 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,14 @@ Concerning the data files: - `requirement-pairs.json` - Contains a list of requirement pairs from the Qt's public JIRA repository which are identified as duplicates (1436) and not-duplicates (1499) +Additionally, 3 OpenReq JSON instances for testing and usage purposes are provided at `src/main/resources/request_examples`. These files are: + +- `requirementsAndProjects.json` - A JSON file in the OpenReq Schema containing a subset of the requirements and projects used for the validation + +- `duplicates.json` - A JSON file in the OpenReq Schema containing a subset of the duplicate and not-duplicate relations used for the validation + +- `OpenReqSchema.json` - A JSON file in the OpenReq Schema containing the requirements, the projects and the duplicates in the previous files + ### Release A stable release (v1.0) is published at: https://github.com/quim-motger/tfm/releases/tag/v1.0