1204766SjkimWelcome to the Kyua project!
2204766Sjkim============================
3204766Sjkim
4204766SjkimKyua is a **testing framework** for infrastructure software, originally
5204766Sjkimdesigned to equip BSD-based operating systems with a test suite.  This
6204766Sjkimmeans that Kyua is lightweight and simple, and that Kyua integrates well
7217365Sjkimwith various build systems and continuous integration frameworks.
8245582Sjkim
9204766SjkimKyua features an **expressive test suite definition language**, a **safe
10204766Sjkimruntime engine** for test suites and a **powerful report generation
11217365Sjkimengine**.
12217365Sjkim
13217365SjkimKyua is for **both developers *and* users**, from the developer applying a
14217365Sjkimsimple fix to a library to the system administrator deploying a new release
15217365Sjkimon a production machine.
16217365Sjkim
17217365SjkimKyua is **able to execute test programs written with a plethora of testing
18217365Sjkimlibraries and languages**.  The library of choice is
19217365Sjkim[ATF](https://github.com/jmmv/atf/), for which Kyua was originally
20217365Sjkimdesigned, but simple, framework-less test programs and TAP-compliant test
21217365Sjkimprograms can also be executed through Kyua.
22217365Sjkim
23217365SjkimKyua is licensed under a **[liberal BSD 3-clause license](LICENSE)**.
24217365SjkimThis is not an official Google product.
25204766Sjkim
26217365Sjkim[Read more about Kyua in the About wiki page.](../../wiki/About)
27217365Sjkim
28217365Sjkim
29204766SjkimDownload
30217365Sjkim--------
31217365Sjkim
32217365SjkimThe latest version of Kyua is 0.13 and was released on August 26th, 2016.
33217365Sjkim
34217365SjkimDownload: [kyua-0.13](../../releases/tag/kyua-0.13).
35217365Sjkim
36217365SjkimSee the [release notes](NEWS.md) for information about the changes in this
37217365Sjkimand all previous releases.
38217365Sjkim
39217365Sjkim
40217365SjkimInstallation
41217365Sjkim------------
42217365Sjkim
43204766SjkimYou are encouraged to install binary packages for your operating system
44204766Sjkimwherever available:
45204766Sjkim
46204773Sjkim* Fedora 20 and above: install the `kyua-cli` package with `yum install
47204766Sjkim  kyua-cli`.
48204773Sjkim
49204766Sjkim* FreeBSD 10.0 and above: install the `kyua` package with `pkg install kyua`.
50204766Sjkim
51204766Sjkim* NetBSD with pkgsrc: install the `pkgsrc/devel/kyua` package.
52204766Sjkim
53204766Sjkim* OpenBSD with packages: install the `kyua` package with `pkg_add kyua`.
54204766Sjkim
55204766Sjkim* OS X (with Homebrew): install the `kyua` package with `brew install kyua`.
56204766Sjkim
57218590SjkimShould you want to build and install Kyua from the source tree provided
58218590Sjkimhere, follow the instructions in the
59218590Sjkim[INSTALL.md file](INSTALL.md).
60218590Sjkim
61218590SjkimYou should also install the ATF libraries to assist in the development of
62204766Sjkimtest programs.  To that end, see the
63204766Sjkim[ATF project page](https://github.com/jmmv/atf/).
64204766Sjkim
65204766Sjkim
66204766SjkimContributing
67204766Sjkim------------
68204766Sjkim
69245582SjkimWant to contribute?  Great!  But please first read the guidelines provided
70204766Sjkimin [CONTRIBUTING.md](CONTRIBUTING.md).
71204766Sjkim
72204766SjkimIf you are curious about who made this project possible, you can check out
73204766Sjkimthe [list of copyright holders](AUTHORS) and the [list of
74204766Sjkimindividuals](CONTRIBUTORS).
75204766Sjkim
76204766Sjkim
77204766SjkimSupport
78204766Sjkim-------
79204766Sjkim
80204766SjkimPlease use the [kyua-discuss mailing
81204766Sjkimlist](https://groups.google.com/forum/#!forum/kyua-discuss) for any support
82204766Sjkiminquiries.
83204766Sjkim
84204766Sjkim*Homepage:* https://github.com/jmmv/kyua/
85204766Sjkim