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/freebsd/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.25](../../releases/tag/atf-0.25), released on September 2nd, 2026. 22 23## Installation 24 25You are encouraged to install binary packages for your operating system 26wherever available: 27 28* FreeBSD 10.0 and above: install the `atf` package with `pkg install atf`. 29 30* NetBSD with pkgsrc: install the `pkgsrc/devel/atf` package. 31 32* OpenBSD: install the `devel/atf` package with `pkg_add atf`. 33 34* Ubuntu: install the `libatf-dev` and `atf-sh` packages with 35 `apt install libatf-dev atf-sh`. 36 37Should you want to build and install ATF from the source tree provided 38here, follow the instructions in the [INSTALL file](INSTALL.md). 39 40## More Reading 41 42* AUTHORS: List of authors and contributors for this project. 43 44* COPYING: License information. 45 46* INSTALL.md: Compilation and installation instructions. These is not the 47 standard document shipped with many packages, so be sure to read it for 48 things that are specific to ATF's build. 49 50* NEWS.md: List of major changes between formal, published releases. 51 52## Other documents 53 54* `AUTHORS`: List of authors and contributors for this project. 55 56* `COPYING`: License information. 57 58* `INSTALL.md`: Compilation and installation instructions. These is not the 59 standard document shipped with many packages, so be sure to read it for 60 things that are specific to ATF's build. 61 62* `NEWS.md`: List of major changes between formal, published releases. 63 64## Support 65 66Please use the 67[FreeBSD-testing@FreeBSD.org](mailto:FreeBSD-testing@FreeBSD.org) mailing list 68for any support inquiries related to `atf-c`, `atf-c++`, `atf-sh`, or `kyua`. 69