1 # Welcome to the ATF project!
3 ATF, or Automated Testing Framework, is a **collection of libraries** to
4 write test programs in **C, C++ and POSIX shell**.
6 The ATF libraries offer a simple API. The API is orthogonal through the
7 various bindings, allowing developers to quickly learn how to write test
8 programs in different languages.
10 ATF-based test programs offer a **consistent end-user command-line
11 interface** to allow both humans and automation to run the tests.
13 ATF-based test programs **rely on an execution engine** to be run and
14 this execution engine is *not* shipped with ATF.
15 **[Kyua](https://github.com/jmmv/kyua/) is the engine of choice.**
19 Formal releases for source files are available for download from GitHub:
21 * [atf 0.20](../../releases/tag/atf-0.20), released on February 7th, 2014.
25 You are encouraged to install binary packages for your operating system
28 * Fedora 20 and above: install the `atf` package with `yum install atf`.
30 * FreeBSD 10.0 and above: install the `atf` package with `pkg install atf`.
32 * NetBSD with pkgsrc: install the `pkgsrc/devel/atf` package.
34 * OpenBSD: install the `devel/atf` package with `pkg_add atf`.
36 Should you want to build and install ATF from the source tree provided
37 here, follow the instructions in the [INSTALL file](INSTALL).
42 [atf-discuss mailing list](https://groups.google.com/forum/#!forum/atf-discuss)
43 for any support inquiries related to `atf-c`, `atf-c++` or `atf-sh`.
45 If you have any questions on Kyua proper, please use the
46 [kyua-discuss mailing list](https://groups.google.com/forum/#!forum/kyua-discuss)