1= YAPET - Installation Instructions
2Rafael Ostertag <rafi@guengel.ch>
3
4== Build Prerequisites
5
6YAPET was designed to have only few library dependencies, and to build
7on most popular Unixes.
8
9To build YAPET, you need the following libraries
10
11* https://www.openssl.org">https://www.openssl.org[OpenSSL]
12* Curses or https://www.gnu.org/software/ncurses/[Ncurses]
13* https://github.com/P-H-C/phc-winner-argon2[Argon2]
14* https://freedesktop.org/wiki/Software/cppunit/[CppUnit]
15
16CppUnit is only used during build to perform unit tests. It is not required to run YAPET.
17
18As of version 0.3, YAPET uses GNU Gettext for
19internationalization. Hence GNU Gettext is an optional dependency.
20
21== Supported Compilers
22
23YAPET is written in {cpp}, so you obviously need a {cpp} compiler to
24compile. It compiles out of the box using the following compilers:
25
26* Clang
27* GNU GCC
28
29== Brief Build Instructions
30
31YAPET uses a `configure` script as generated by `autoconf` and friends
32for configuring the build process of YAPET. Change to the directory
33where you unpacked `YAPET` and simply type
34
35 # ./configure
36
37on the command line. The `configure` script will then check the system
38and prepare for the build process.
39
40If the `configure` script successfully finishes, type
41
42 # make
43
44YAPET will now be built. After the build has finished you can
45
46 # sudo make install
47
48This will install YAPET into the `/usr/local/bin` directory, if the prefix has
49not been changed.
50