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