summaryrefslogtreecommitdiff
path: root/lib/README.txt
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2021-10-04 14:42:32 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2021-10-04 14:42:32 +0200
commit10da46a5a62012fb6467ef48cc8cabd05690262a (patch)
tree215a7efc4c2922d0d57c15b3c30f194000c86690 /lib/README.txt
parentcc82b742be31a377c88a997f830471e4a8c04fe0 (diff)
Improve documentation about library build folders and more
lib/README.txt: clarify where built libraries are located documentation/src/basics.dox: clarify (C++) compiler command usage and improve documentation of the fltk-config script
Diffstat (limited to 'lib/README.txt')
-rw-r--r--lib/README.txt43
1 files changed, 27 insertions, 16 deletions
diff --git a/lib/README.txt b/lib/README.txt
index 61779843f..24938befd 100644
--- a/lib/README.txt
+++ b/lib/README.txt
@@ -1,16 +1,27 @@
-README.lib
-----------
-
-This README file is a placeholder for library files on your
-system.
-
-Under Microsoft Windows a successful build of all projects and
-configurations will contain debug and release libraries for you
-to link to - all are built using the multi-threaded DLL
-settings. The DLL files (fltkdll.dll and fltkdlld.dll) required
-for a complete DLL-based binary distribution are located in the
-"visualc" directory.
-
-Under UNIX a single set of library files will be built, with or
-without debug information depending on the options you provided
-to the configure script.
+lib/README.txt
+--------------
+
+This README file is a placeholder for FLTK library files on your system
+if FLTK is built using 'configure' and 'make'.
+
+
+Building FLTK with CMake
+
+If FLTK is built using CMake all static and shared libraries are created
+in the 'lib' subdirectory of the build tree. We strongly recommend to
+build with CMake outside the source tree ("out-of-tree") as described
+in README.CMake.txt in the root folder of the FLTK distribution.
+
+If FLTK is built out-of-tree as recommende this folder will not be touched.
+
+
+Building FLTK with configure + make
+
+Under UNIX/Linux and other systems that support 'configure' and 'make'
+(e.g. MinGW, MSYS) a single set of library files will be built, with
+or without debug information depending on the options you provided to
+the configure script.
+
+The FLTK build system based on configure does not support out-of-tree
+builds, hence the static libraries will be built in this 'lib' folder
+and the shared libraries (if enabled) can be found in the 'src' folder.