README.md

   1 Welcome to the Kyua project!
   2 ============================
   3
   4 Kyua is a **testing framework** for infrastructure software, originally
   5 designed to equip BSD-based operating systems with a test suite.  This
   6 means that Kyua is lightweight and simple, and that Kyua integrates well
   7 with various build systems and continuous integration frameworks.
   8
   9 Kyua features an **expressive test suite definition language**, a **safe
  10 runtime engine** for test suites and a **powerful report generation
  11 engine**.
  12
  13 Kyua is for **both developers *and* users**, from the developer applying a
  14 simple fix to a library to the system administrator deploying a new release
  15 on a production machine.
  16
  17 Kyua is **able to execute test programs written with a plethora of testing
  18 libraries and languages**.  The library of choice is
  19 [ATF](https://github.com/jmmv/atf/), for which Kyua was originally
  20 designed, but simple, framework-less test programs and TAP-compliant test
  21 programs can also be executed through Kyua.
  22
  23 Kyua is licensed under a **[liberal BSD 3-clause license](LICENSE)**.
  24 This is not an official Google product.
  25
  26 [Read more about Kyua in the About wiki page.](../../wiki/About)
  27
  28
  29 Download
  30 --------
  31
  32 The latest version of Kyua is 0.13 and was released on August 26th, 2016.
  33
  34 Download: [kyua-0.13](../../releases/tag/kyua-0.13).
  35
  36 See the [release notes](NEWS.md) for information about the changes in this
  37 and all previous releases.
  38
  39
  40 Installation
  41 ------------
  42
  43 You are encouraged to install binary packages for your operating system
  44 wherever available:
  45
  46 * Fedora 20 and above: install the `kyua-cli` package with `yum install
  47   kyua-cli`.
  48
  49 * FreeBSD 10.0 and above: install the `kyua` package with `pkg install kyua`.
  50
  51 * NetBSD with pkgsrc: install the `pkgsrc/devel/kyua` package.
  52
  53 * OpenBSD with packages: install the `kyua` package with `pkg_add kyua`.
  54
  55 * OS X (with Homebrew): install the `kyua` package with `brew install kyua`.
  56
  57 Should you want to build and install Kyua from the source tree provided
  58 here, follow the instructions in the
  59 [INSTALL.md file](INSTALL.md).
  60
  61 You should also install the ATF libraries to assist in the development of
  62 test programs.  To that end, see the
  63 [ATF project page](https://github.com/jmmv/atf/).
  64
  65
  66 Contributing
  67 ------------
  68
  69 Want to contribute?  Great!  But please first read the guidelines provided
  70 in [CONTRIBUTING.md](CONTRIBUTING.md).
  71
  72 If you are curious about who made this project possible, you can check out
  73 the [list of copyright holders](AUTHORS) and the [list of
  74 individuals](CONTRIBUTORS).
  75
  76
  77 Support
  78 -------
  79
  80 Please use the [kyua-discuss mailing
  81 list](https://groups.google.com/forum/#!forum/kyua-discuss) for any support
  82 inquiries.
  83
  84 *Homepage:* https://github.com/jmmv/kyua/