Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
97 lines (62 sloc) 6.32 KB

OFT logo OpenFastTrace

What is OpenFastTrace?

OpenFastTrace (short OFT) is a requirement tracing suite. Requirement tracing helps you keeping track of whether you actually implemented everything you planned to in your specifications. It also identifies obsolete parts of your product and helps you getting rid of them.

You can learn more about requirement tracing and how to use OpenFastTrace in the user guide.

Below you see a screenshot of of a HTML tracing report where OFT traces itself. You see a summary followed by a detail view of the traced requirements.

OFT HTML tracing report

Project Information

Build Status Circle CI codecov Coverity Scan Build Status Download Maven Central

Sonarcloud status:

Quality Gate Bugs Code smells Coverage Duplicated Lines Lines of Code Maintainability Rating Reliability Rating Security Rating Technical Dept Vulnerabilities

Quick Links

Using OpenFastTrace

If you want to use OFT, you have the choice between using it as part of your build process — typically with Maven or Gradle. Or you can run OFT from the command line.

Check the user guide for detailed information on how to use OpenFastTrack.

Getting OpenFastTrace

OpenFastTrace at it's core is a Java Archive (short "[JAR]"(https://docs.oracle.com/javase/8/docs/technotes/guides/jar/jar.html#JAR%20Manifest)). This file contains the OpenFastTrace Library and an entry point for running OFT from the command line.

Getting Pre-Built Packages

Pre-Built JAR files (called openfasttrace-2.2.0.jar) are available from the following places:

Check our [developer guide](doc/developer_guide.md#getting-the-openfasttrace-library] to learn how to use the OFT JAR as dependency in your own code with popular build tools.

Installation

Runtime Dependencies

OpenFastTrace only needs a Java 8 (or later) runtime environment to run.

Installation of Runtime Dependencies on Linux

Ubuntu or Debian

If you just want to run OFT:

apt-get install openjdk-8-jre

Running OpenFastTrace

The most basic variant to run OpenFastTrace is directly from the JAR file via the command line:

java -jar openfasttrace-2.2.0.jar trace /path/to/directory/being/traced

If you want to run OFT automatically as part of a continuous build, we recommend using our Gradle Plugin.

For more details about how to run OFT please consult the user guide.

Development

If you want to learn how to build OpenFastTrace, please check our Developer Guide.

You would like to contribute to OFT? Please check out our Contributor Guide to get started.