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