mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation fixes.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11862 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2016-08-01 12:50:15 +00:00
parent 6b0e38942f
commit fe0c247dbb
2 changed files with 46 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.CMake.txt
View File

@ -58,7 +58,7 @@ More information on CMake can be found on its web site http://www.cmake.org.
--------------- ---------------
The prerequisites for building FLTK with CMake are staightforward: The prerequisites for building FLTK with CMake are staightforward:
CMake 2.6 or later and a recent FLTK 1.3 release, snapshot, or subversion CMake 2.6.3 or later and a recent FLTK 1.3 release, snapshot, or subversion
download (working copy). Installation of CMake is covered on its web site. download (working copy). Installation of CMake is covered on its web site.
This howto will cover building FLTK with the default options using cmake This howto will cover building FLTK with the default options using cmake
@ -85,7 +85,7 @@ CMAKE_BUILD_TYPE
by CMake depending on this value. by CMake depending on this value.
CMAKE_INSTALL_PREFIX CMAKE_INSTALL_PREFIX
Where everything will go on install. Defaults are /usr/local for unix Where everything will go on install. Defaults are /usr/local for Unix
and C:\Program Files\FLTK for Windows. and C:\Program Files\FLTK for Windows.
The following are the FLTK specific options. Platform specific options The following are the FLTK specific options. Platform specific options
@ -136,7 +136,19 @@ OPTION_USE_SYSTEM_LIBPNG - default ON
OPTION_USE_XINERAMA - default ON OPTION_USE_XINERAMA - default ON
OPTION_USE_XFT - default ON OPTION_USE_XFT - default ON
OPTION_USE_XDBE - default ON OPTION_USE_XDBE - default ON
OPTION_USE_XCURSOR - default ON
OPTION_USE_XRENDER - default ON
These are X11 extended libraries. These are X11 extended libraries.
OPTION_ABI_VERSION - default EMPTY
Use a numeric value corresponding to the FLTK ABI version you want to
build in the form 1xxyy for FLTK 1.x.y (xx and yy with leading zeroes).
The default ABI version is 1xx00 (the stable ABI throughout all patch
releases of one minor FLTK version). The highest ABI version you may
choose is 1xxyy for FLTK 1.x.y (again with leading zeroes).
Please see README.abi-version.txt for more information about which
ABI version to select.
OPTION_PRINT_SUPPORT - default ON OPTION_PRINT_SUPPORT - default ON
When turned off, the Fl_Printer class does nothing and the When turned off, the Fl_Printer class does nothing and the
Fl_PostScript_File_Device class cannot be used, but the FLTK library Fl_PostScript_File_Device class cannot be used, but the FLTK library
@ -153,7 +165,7 @@ the following.
cd build cd build
cmake .. cmake ..
make make
sudo make install sudo make install (optional)
This will build and install a default configuration FLTK. This will build and install a default configuration FLTK.
@ -163,6 +175,18 @@ Some flags can be changed during the 'make' command, such as:
..which builds in verbose mode, so you can see all the compile/link commands. ..which builds in verbose mode, so you can see all the compile/link commands.
Hint: if you intend to build several different versions of FLTK, e.g. a Debug
and a Release version, or multiple libraries with different ABI versions,
then use subdirectories in the build directory, like this:
mkdir build
cd build
mkdir Debug
cd Debug
cmake ../..
make
sudo make install (optional)
CROSSCOMPILING CROSSCOMPILING
---------------- ----------------
@ -228,7 +252,7 @@ Here is a basic CMakeLists.txt file using FLTK.
------ ------
cmake_minimum_required(VERSION 2.6) cmake_minimum_required(VERSION 2.6.3)
project(hello) project(hello)
@ -269,7 +293,7 @@ a gui app. It is ignored on other platforms.
LIBRARY NAMES LIBRARY NAMES
--------------- ---------------
When you use the target_link_libraries command, CMake uses it's own When you use the target_link_libraries command, CMake uses its own
internal names for libraries. The fltk library names are: internal names for libraries. The fltk library names are:
fltk fltk_forms fltk_images fltk_gl fltk fltk_forms fltk_images fltk_gl
@ -295,11 +319,11 @@ Here is a sample CMakeLists.txt which compiles the CubeView example from
a directory you've copied the test/Cube* files to. a directory you've copied the test/Cube* files to.
--- ---
cmake_minimum_required(VERSION 2.6) cmake_minimum_required(VERSION 2.6.3)
project(CubeView) project(CubeView)
# change this to your fltk buid directory # change this to your fltk build directory
set(FLTK_DIR /home/msurette/build/fltk-release/) set(FLTK_DIR /home/msurette/build/fltk-release/)
find_package(FLTK REQUIRED NO_MODULE) find_package(FLTK REQUIRED NO_MODULE)
@ -313,7 +337,7 @@ add_custom_command(
include_directories(${CMAKE_BINARY_DIR}) include_directories(${CMAKE_BINARY_DIR})
include_directories(${CMAKE_SOURCE_DIR}) include_directories(${CMAKE_SOURCE_DIR})
add_executable(CubeView WIN32 CubeMain.cxx CubeView.cxx CubeViewUI.cxx) add_executable(CubeView WIN32 CubeMain.cxx CubeView.cxx CubeViewUI.cxx)
target_link_libraries(CubeView fltk fltk_gl) target_link_libraries(CubeView fltk fltk_gl)
--- ---

20
README.Unix.txt
View File

@ -38,7 +38,7 @@ README.Unix.txt - 2010-11-14 - Building FLTK on Unix
1 INTRODUCTION 1 INTRODUCTION
================= =================
FLTK currently supports the following development environments on vmost Unix FLTK currently supports the following development environments on most Unix
platforms: platforms:
- gcc command line tools - gcc command line tools
@ -305,13 +305,13 @@ Now configure your FLTK installation:
./configure ./configure
ADVANCED: type "./configure --help" to get a complete list of optional ADVANCED: type "./configure --help" to get a complete list of optional
configurations parameters. These should be pretty self-explanatory. Some configuration parameters. These should be pretty self-explanatory. Some
more details can be found in README. more details can be found in README.
:END_ADVANCED :END_ADVANCED
The configuration script will check your machine for the required resources The configuration script will check your machine for the required resources
which you should have installed as described in the Prerequisites chapter. Review which you should have installed as described in the Prerequisites chapter.
the Configuration Summary, maybe take some notes. Review the Configuration Summary, maybe take some notes.
3.3 Building FLTK 3.3 Building FLTK
@ -325,8 +325,8 @@ The entire FLTK toolkit including many test programs will be built for you. No
warnings should appear. If some do, please let the FLTK developer team know via warnings should appear. If some do, please let the FLTK developer team know via
the mailing list or the bug reporting template at www.fltk.org . the mailing list or the bug reporting template at www.fltk.org .
Actually, as of Oct 28 2010, quite a bunch of warnings will show, mostly about Actually, as of Apr 13 2016, one or two warnings will show, mostly about
suggested parenthesis. Please ignore them until we can fix them. deprecated declarations. Please ignore them.
3.4 Testing FLTK 3.4 Testing FLTK
@ -362,8 +362,8 @@ installation path to a location within the user account by adding the
FLTK provides a neat script named "fltk-config" that can provide all the flags FLTK provides a neat script named "fltk-config" that can provide all the flags
needed to build FLTK applications using the same flags that were used to build needed to build FLTK applications using the same flags that were used to build
the library itself. Running "fltk-config" without arguments will print a list the library itself. Running "fltk-config" without arguments will print a list
options. The easiest call to compile an FLTK application from a single source of options. The easiest call to compile an FLTK application from a single
file is: source file is:
fltk-config --compile myProgram.cxx fltk-config --compile myProgram.cxx
@ -390,7 +390,7 @@ version 10.05:
Start Code::Blocks. Select File > New > Project. In the "New from template" Start Code::Blocks. Select File > New > Project. In the "New from template"
dialog box, click on "FLTK project" and follow the instructions. dialog box, click on "FLTK project" and follow the instructions.
The default project support basic fltk. If you would like to add support for The default project supports basic fltk. If you would like to add support for
images, OpenGL, GLUT, or Forms, add the corresponding flags --use-images, images, OpenGL, GLUT, or Forms, add the corresponding flags --use-images,
--use-gl, --use-glut, and --use-forms respectively. --use-gl, --use-glut, and --use-forms respectively.
@ -403,7 +403,7 @@ The linker flags are located in the "Linker Settings" tab under "Other Linker
Options". Add the flags to `fltk-config --ldstaticflags` in front of the Options". Add the flags to `fltk-config --ldstaticflags` in front of the
second "`". second "`".
CodeBlocks can be set up to use fluid to manage modules.. CodeBlocks can be set up to use fluid to manage modules.
The following info is from mingodad@gmail.com posted on fltk.general 06/17/2013: The following info is from mingodad@gmail.com posted on fltk.general 06/17/2013:
""" """