From 5f40f148b6263942941f617601603f7c5d685c2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20H=C3=BCttel?= Date: Wed, 3 Jul 2019 21:33:16 +0200 Subject: [PATCH] Update doxygen: Windows compilation --- doxygen/compilation.dox | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/doxygen/compilation.dox b/doxygen/compilation.dox index feae75a..56d0d42 100644 --- a/doxygen/compilation.dox +++ b/doxygen/compilation.dox @@ -21,16 +21,16 @@ 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 + - More or less optional: git. Used for extraction of the precise version number. It is strongly recommended to provide git! - 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): +Development is done with the following library versions: -| Cairographics | GLib2 | GTK3 | -| ------------- | ---------- | -------- | -| 1.16.0-2 | 2.60.4-1 | 3.24.9-1 | +| Cairographics | GLib2 | GTK3 | +| ------------- | ---------- | ------ | +| 1.16.0-2 | 2.60.0-1 | 3.24.7 | @section comp-instr Compilation Instructions @subsection linux-build General Linux Build Instruction @@ -57,11 +57,32 @@ in order to build the program and The subfolder 'AUR' contains a PKGBUILD file to build an Archlinux/Pacman package. -@subsection Compiler Warnings +@subsection comp-warnings Compiler Warnings -The compiler will throw the following warnings. Compiled with GCC 9.1.0. +The compiler will throw the following warnings. Compiled with GCC 8.2.1. | Warning | Assessment | | ------- | ---------- | | warning: ‘calculate_path_miter_points’ defined but not used [-Wunused-function] | Ignore. Function will be used in later versions. | + + +@subsection windows-compilation Compilation for Windows + +@warning Windows is not a target system for this application, considering that this program converts GDS files which are most likely generated under a Linux system. The tips shown in this section are a guidance for anyone trying to build this application for Windows. + +@warning Note that the Windows compatibility may decrease in future releases and a simple compilation like with this version might not be possible anymore. + +The current release of 'gds-render' does not compile under a windows system, due to incompatibilities in the external library renderer. +It is possible to comment out the code that causes the incompatibility. The external renderer will not be usable after this. + +Steps: + + - Go to file external-renderer.c + - Remove `#include` + - comment out all code in #external_renderer_render_cell + +The program should now compile. + +@note In versions currently in development, the cairo renderer will be unusable under Windows due to Issue `#16`. So you might want to stick with this version. + */