68 lines
2.0 KiB
Plaintext
68 lines
2.0 KiB
Plaintext
/**
|
||
|
||
@page compilation Compilation
|
||
|
||
@section Preface
|
||
|
||
GDS-Render is designed for UNIX-like, especially GNU/Linux based systems.
|
||
It was developed under a Linux system. Therefore, best performance is expected using a Linux operating system.
|
||
|
||
@section depencencies Dependencies
|
||
The dependencies of GDS-Render are:
|
||
|
||
@subsection run-deps Program Dependencies
|
||
|
||
- GLib2
|
||
- GTK3
|
||
- Cairographics
|
||
|
||
@subsection comp-deps Compilation Dependencies
|
||
These dependencies are not needed for running the program; just for compilation.
|
||
|
||
- Build System (GCC + binutils, make, etc...). Most distributions supply a "development" meta-package containing this stuff.
|
||
- cmake >= 2.8
|
||
- git: git is required for generating the version number during compilation
|
||
- Optional: doxygen for this nice documentation.
|
||
|
||
The dependency list of GTK3 already includes Cairographics and GLib2. You should be on the safe side with a recent GTK3 version.
|
||
|
||
Development is done with the following library versions (this is updated regularily):
|
||
|
||
| Cairographics | GLib2 | GTK3 |
|
||
| ------------- | ---------- | -------- |
|
||
| 1.16.0-2 | 2.60.4-1 | 3.24.9-1 |
|
||
|
||
@section comp-instr Compilation Instructions
|
||
@subsection linux-build General Linux Build Instruction
|
||
Go to the build directory you want to compile in. This may be the gds-render project root.
|
||
Execute
|
||
@code
|
||
cmake <Path to gds-render root>
|
||
@endcode
|
||
|
||
Cmake will check the dependencies. Once cmake has finished. Type
|
||
|
||
@code
|
||
make
|
||
@endcode
|
||
|
||
in order to build the program and
|
||
|
||
@code
|
||
make documentation
|
||
@endcode
|
||
to build the doxygen documentation.
|
||
|
||
@subsection arch-makepkg Archlinux Package
|
||
|
||
The subfolder 'AUR' contains a PKGBUILD file to build an Archlinux/Pacman package.
|
||
|
||
@subsection Compiler Warnings
|
||
|
||
The compiler will throw the following warnings. Compiled with GCC 9.1.0.
|
||
|
||
| Warning | Assessment |
|
||
| ------- | ---------- |
|
||
| warning: ‘calculate_path_miter_points’ defined but not used [-Wunused-function] | Ignore. Function will be used in later versions. |
|
||
*/
|