Download the library
The following descriptions apply to Aquila 3 only. For the older version, see the section Aquila 2.5 at the bottom of this page.
Build from source
- Aquila relies on CMake as a build tool, so make sure you have it installed (version 2.8 or later).
- Qt (optionally)
- All GUI examples use Qt as the widget toolkit. Qt is an extensive and cross-platform UI framework.
- SFML (optionally)
- SFML was chosen as media playback and acqusition library.
Get the code
As the library is still under development and changes are made frequently, it is advised to get the code from version control system. Simply clone our official Git repository using the command below, which will create a directory called
aquila-src and place there the source code of the library.
git clone git://github.com/zsiciarz/aquila.git aquila-src
If you do not have Git installed, below are download links to most up-to-date code in master branch (also directing to Github):
Short digression about where to build
CMake encourages out-of-source builds, which means that the resulting binaries will be created in a directory that is separate from the place where source code lives. This is a good practice as object files, executables and various other generated files don't clutter the source directory. Therefore we recommend building Aquila out-of-source. Let's assume a following directory structure:
a-top-level-directory/ aquila-build/ aquila-src/
aquila-src is the directory where source code is located (either cloned from Git repository or unpacked from the archive).
aquila-build is the place where the actual build will happen.
The following options can be set at command-line to configure build:
- The directory where you want Aquila to be installed. This setting does not affect the build step, it only tells
make installwhere to copy compiled libraries and header files.
An example CMake invocation follows (with Windows-specific settings):
cmake ..\aquila-src -DCMAKE_INSTALL_PREFIX="D:\Libs\aquila"
Note: I've placed the arguments to
cmake in multiple lines for clarity, but in reality this statement should be a one-liner.
Build and install
Windows (MinGW) users should replace
mingw32-make in the instructions below.
make make install
If all goes well, the library will build and then install to the specified path. The
make install step may require administrator rights. That's it - the library is now built, installed and ready to use.
Examples and tests
To see what the library can do, run
make examples after installation, while still in the build directory. This will build several example programs showing some of Aquila features (some of these examples are here on the site). These programs can then be found in the examples subdirectory of the build directory. Building and running tests is covered on the Development page.