correct typo, format line breaks < 80 columns in README.OSX.txt

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11496 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser
2016-04-01 11:11:11 +00:00
parent f1a157bdd9
commit 88ab084e9a
+84 -80
View File
@@ -1,10 +1,10 @@
README.OSX.txt - 2010-10-23 - Building FLTK under Apple OS X README.OSX.txt - 2016-04-01 - Building FLTK under Apple OS X
------------------------------------------------------------ ------------------------------------------------------------
CONTENTS CONTENTS
========== ==========
1 INTRODUCTION 1 INTRODUCTION
2 HOW TO BUILD FLTK USING GCC 2 HOW TO BUILD FLTK USING GCC
@@ -48,9 +48,9 @@ platform:
- gcc command line tools - gcc command line tools
- Xcode 3.x and higher - Xcode 3.x and higher
CAUTION: gcc command line built libraries and Xcode created Frameworks should CAUTION: gcc command line built libraries and Xcode created Frameworks should
not be mixed! not be mixed!
2 HOW TO BUILD FLTK USING GCC 2 HOW TO BUILD FLTK USING GCC
@@ -64,8 +64,8 @@ In order to build FLTK from the command line, you need to install the Xcode
developer environment. It can be downloaded from the Apple Store for free. developer environment. It can be downloaded from the Apple Store for free.
After downloading and installing, you need to launch the Terminal. Terminal.app After downloading and installing, you need to launch the Terminal. Terminal.app
is located in the "Utilities" folder inside the "Applications" folder. I like to is located in the "Utilities" folder inside the "Applications" folder. I like
keep the Terminal in the Dock. to keep the Terminal in the Dock.
2.2 Downloading and Unpacking 2.2 Downloading and Unpacking
@@ -75,9 +75,9 @@ Download FLTK from here:
http://www.fltk.org/software.php http://www.fltk.org/software.php
If you are familiar with "subversion" and like to stay current with your If you are familiar with "subversion" and like to stay current with your
version, you will find the subversion access parameters at the bottom of that version, you will find the subversion access parameters at the bottom of that
page. Unpack FLTK into a convenient location. I like to have everything in my page. Unpack FLTK into a convenient location. I like to have everything in my
dev directory: dev directory:
cd cd
@@ -87,8 +87,8 @@ dev directory:
tar xvfz fltk-1.3.xxxx.tar.gz tar xvfz fltk-1.3.xxxx.tar.gz
cd fltk-1.3.xxxx cd fltk-1.3.xxxx
If you got FLTK via subversion then you need one extra step: build the configure script. If you got FLTK via subversion then you need one extra step: build the
Otherwise skip the following part marked ADVANCED: configure script. Otherwise skip the following part marked ADVANCED:
ADVANCED: (only if you got FLTK via subversion) ADVANCED: (only if you got FLTK via subversion)
- The preferred procedure is to build the configure script using tools - The preferred procedure is to build the configure script using tools
@@ -111,35 +111,36 @@ ADVANCED: (only if you got FLTK via subversion)
----------------------- -----------------------
Now configure your FLTK installation: stay in your FLTK source-code directory and type Now configure your FLTK installation: stay in your FLTK source-code directory
and type
./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 configurations parameters. These should be pretty self-explanatory. Some
more details can be found in README. more details can be found in README.
To create multi-architecture binaries, start "configure" with these flags: To create multi-architecture binaries, start "configure" with these flags:
./configure --with-archflags="-arch i386 -arch x86_64" ./configure --with-archflags="-arch i386 -arch x86_64"
To create applications that can run under Mac OS X 10.4 and above, use these flags: To create applications that can run under Mac OS X 10.4 and above, use these flags:
./configure CXXFLAGS="-mmacosx-version-min=10.4" LDFLAGS="-mmacosx-version-min=10.4" ./configure CXXFLAGS="-mmacosx-version-min=10.4" LDFLAGS="-mmacosx-version-min=10.4"
: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 should all have been part of your Xcode installation. Review the which should all have been part of your Xcode installation. Review the
Configuration Summary, maybe take some notes. Configuration Summary, maybe take some notes.
2.4 Building FLTK 2.4 Building FLTK
-------------------- --------------------
Now this is easy. Stay in your FLTK source-code directory and type: Now this is easy. Stay in your FLTK source-code directory and type:
make make
The entire FLTK toolkit including many test programs will be built for you. No The entire FLTK toolkit including many test programs will be built for you. No
warnings should appear, but "ranlib" may complain about a few modules having no warnings should appear, but "ranlib" may complain about a few modules having no
symbols. This is normal and can safely be ignored. symbols. This is normal and can safely be ignored.
@@ -155,27 +156,27 @@ After a successful build, you can test FLTK's capabilities:
2.6 Installing FLTK 2.6 Installing FLTK
---------------------- ----------------------
If you did not change any of the configuration settings, FLTK will be installed If you did not change any of the configuration settings, FLTK will be installed
in "/usr/local/include" and "/usr/local/lib" by typing in "/usr/local/include" and "/usr/local/lib" by typing
sudo make install sudo make install
It is possible to install FLTK without superuser privileges by changing the It is possible to install FLTK without superuser privileges by changing the
installation path to a location within the user account by adding the installation path to a location within the user account by adding the
"--prefix=PREFIX" parameter to the "./configure" command. "--prefix=PREFIX" parameter to the "./configure" command.
2.7 Creating new Projects 2.7 Creating new Projects
---------------------------- ----------------------------
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. Architecture flags (e.g., -arch i386) used to build the the library itself. Architecture flags (e.g., -arch i386) used to build the
library, though, are not provided by the fltk-config script. This allows to library, though, are not provided by the fltk-config script. This allows to
build universal libraries and to produce applications of any architecture build universal libraries and to produce applications of any architecture
from them. Running "fltk-config" without arguments will print a list from them. Running "fltk-config" without arguments will print a list
of 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 source
file is: file is:
fltk-config --compile myProgram.cxx fltk-config --compile myProgram.cxx
@@ -192,7 +193,8 @@ recommend that you add it to the command search path.
-------------------- --------------------
In order to build FLTK from within Xcode 3, you need to have the Xcode 3 In order to build FLTK from within Xcode 3, you need to have the Xcode 3
developer environment on your computer. If you don't, go to: 'HOW TO BUILD FLTK USING XCODE4' developer environment on your computer. If you don't, go to: 'HOW TO BUILD
FLTK USING XCODE4'
3.2 Downloading and Unpacking 3.2 Downloading and Unpacking
@@ -202,8 +204,8 @@ Download FLTK from here:
http://www.fltk.org/software.php http://www.fltk.org/software.php
If you are familiar with "subversion" and like to stay current with your If you are familiar with "subversion" and like to stay current with your
version, you will find the subversion access parameters at the bottom of that version, you will find the subversion access parameters at the bottom of that
page. You can use the SCM system that is built into Xcode. page. You can use the SCM system that is built into Xcode.
Unpack FLTK by double-clicking it and copy the new folder into a convenient Unpack FLTK by double-clicking it and copy the new folder into a convenient
@@ -213,24 +215,24 @@ location. I have set up a "dev" folder in my home folder for all my projects.
3.3 Configuring FLTK 3.3 Configuring FLTK
----------------------- -----------------------
Launch Xcode. Open the project file in Launch Xcode. Open the project file in
.../fltk-1.3.xxxx/ide/Xcode4/FLTK.xcodeproj .../fltk-1.3.xxxx/ide/Xcode4/FLTK.xcodeproj
Use the "Project" pulldown menu to change "Active Build Configuration" to Use the "Project" pulldown menu to change "Active Build Configuration" to
"Release". Change the "Active Architecture" as desired. "Release". Change the "Active Architecture" as desired.
3.4 Building FLTK 3.4 Building FLTK
-------------------- --------------------
Use the "Project" pulldown menu to set the "Active Target" to "Demo". Use the "Project" pulldown menu to set the "Active Target" to "Demo". Select
Select "Build" from the "Build" menu to create all libraries and test applications. "Build" from the "Build" menu to create all libraries and test applications.
By default, the Xcode4 project builds applications that run under Mac OS X 10.5 and above. By default, the Xcode4 project builds applications that run under Mac OS X 10.5
To build applications that run under older Mac OS versions, select "Edit Project Settings" and above. To build applications that also run under older Mac OS versions,
of the Project menu, then select the Build panel, and modify the "Mac OS X Deployment Target" select "Edit Project Settings" of the Project menu, then select the Build panel,
item. and modify the "Mac OS X Deployment Target" item.
All frameworks and apps will be located in "./ide/Xcode4/build/Release/". All frameworks and apps will be located in "./ide/Xcode4/build/Release/".
@@ -248,11 +250,11 @@ to explore all test programs.
Remove FLTK frameworks: Remove FLTK frameworks:
sudo rm -r /Library/Frameworks/fltk*.framework sudo rm -r /Library/Frameworks/fltk*.framework
Remove Fluid and possibly other utilities: Remove Fluid and possibly other utilities:
sudo rm -r /Developer/Applications/Utilities/FLTK/ sudo rm -r /Developer/Applications/Utilities/FLTK/
3.7 Installing FLTK 3.7 Installing FLTK
---------------------- ----------------------
@@ -261,7 +263,7 @@ When distributing FLTK applications, the FLTK frameworks should be made part of
the application package. For development however, it is very convenient to have the application package. For development however, it is very convenient to have
the Release-mode Frameworks in a standard location. the Release-mode Frameworks in a standard location.
For Xcode project template use, all FLTK frameworks should be copied from For Xcode project template use, all FLTK frameworks should be copied from
"./ide/Xcode4/build/Release/" to "/Library/Frameworks/". The FLTK header files "./ide/Xcode4/build/Release/" to "/Library/Frameworks/". The FLTK header files
for all FLTK frameworks will then be at "/Library/Frameworks/fltk.framework/ for all FLTK frameworks will then be at "/Library/Frameworks/fltk.framework/
Headers/". Add this path to the header search path of your projects. Headers/". Add this path to the header search path of your projects.
@@ -269,8 +271,8 @@ Headers/". Add this path to the header search path of your projects.
sudo rm -f -r /Library/Frameworks/fltk* sudo rm -f -r /Library/Frameworks/fltk*
sudo cp -R ide/Xcode4/build/Release/fltk*.framework /Library/Frameworks/ sudo cp -R ide/Xcode4/build/Release/fltk*.framework /Library/Frameworks/
Many FLTK applications will use Fluid, the FLTK User Interface builder, to Many FLTK applications will use Fluid, the FLTK User Interface builder, to
generate C++ source code from .fl resource files. Add Fluid to the developer generate C++ source code from .fl resource files. Add Fluid to the developer
tools: tools:
sudo mkdir /Developer/Applications/Utilities/FLTK/ sudo mkdir /Developer/Applications/Utilities/FLTK/
@@ -285,8 +287,8 @@ tools:
- Project Templates: - Project Templates:
Project Templates are the quickest way to create a new FLTK application from Project Templates are the quickest way to create a new FLTK application from
within Xcode. The included project builds an FLTK based Cocoa application within Xcode. The included project builds an FLTK based Cocoa application
written in C++ with support for the Fluid UI designer, image reading, and written in C++ with support for the Fluid UI designer, image reading, and
OpenGL. Unused FLTK sub-Frameworks can simply be removed from the project. OpenGL. Unused FLTK sub-Frameworks can simply be removed from the project.
The template assumes that Release versions of the FLTK frameworks are installed The template assumes that Release versions of the FLTK frameworks are installed
in /Library/Frameworks as described above. in /Library/Frameworks as described above.
@@ -305,7 +307,7 @@ FLTK 1.3 user template which is ready to compile.
- Fluid file handling - Fluid file handling
This section assumes that a Release version of Fluid is installed in This section assumes that a Release version of Fluid is installed in
"/Developer/Applications/Utilities/FLTK/" as described above. It will install "/Developer/Applications/Utilities/FLTK/" as described above. It will install
a new file type which opens Fluid as an editor for files ending in ".fl". a new file type which opens Fluid as an editor for files ending in ".fl".
@@ -317,10 +319,10 @@ Next, we copy the Fluid specification over:
sudo cp ide/Xcode4/fluid.pbfilespec /Library/Application\ Support/Developer/Shared/Xcode/Specifications/ sudo cp ide/Xcode4/fluid.pbfilespec /Library/Application\ Support/Developer/Shared/Xcode/Specifications/
Open Xcode preferences and select the File Types tab. Find the Open Xcode preferences and select the File Types tab. Find the
"sourcecode.fluid" entry in "file > text > sourcecode" and set the external "sourcecode.fluid" entry in "file > text > sourcecode" and set the external
editor to Fluid. When adding ".fl" files, set the File Type in the Info dialog editor to Fluid. When adding ".fl" files, set the File Type in the Info dialog
to "sourcecode.fluid" and Xcode will edit your file in Fluid when to "sourcecode.fluid" and Xcode will edit your file in Fluid when
double-clicking. double-clicking.
@@ -346,11 +348,11 @@ follow the instructions.
4.1 Prerequisites 4.1 Prerequisites
-------------------- --------------------
In order to build FLTK from within Xcode 4, 5, 6 or 7, you need to install the Xcode In order to build FLTK from within Xcode 4, 5, 6 or 7, you need to install
developer environment via the Apple App Store that comes with Lion and up. the Xcode developer environment via the Apple App Store that comes with
If you also want the command line version of gcc, you can use the Lion and up. If you also want the command line version of gcc, you can use
Download section in the Preferences dialog. the Download section in the Preferences dialog.
4.2 Downloading and Unpacking 4.2 Downloading and Unpacking
-------------------------------- --------------------------------
@@ -359,8 +361,8 @@ Download FLTK from here:
http://www.fltk.org/software.php http://www.fltk.org/software.php
If you are familiar with "subversion" and like to stay current with your If you are familiar with "subversion" and like to stay current with your
version, you will find the subversion access parameters at the bottom of that version, you will find the subversion access parameters at the bottom of that
page. You can use the SCM system that is built into Xcode. page. You can use the SCM system that is built into Xcode.
Unpack FLTK by double-clicking it and copy the new folder into a convenient Unpack FLTK by double-clicking it and copy the new folder into a convenient
@@ -370,26 +372,26 @@ location. I have set up a "dev" folder in my home folder for all my projects.
4.3 Configuring FLTK 4.3 Configuring FLTK
----------------------- -----------------------
Launch Xcode. Open the project file in Launch Xcode. Open the project file in
.../fltk-1.3.xxxx/ide/Xcode4/FLTK.xcodeproj .../fltk-1.3.xxxx/ide/Xcode4/FLTK.xcodeproj
There is nothing else to configure. There is nothing else to configure.
4.4 Building FLTK 4.4 Building FLTK
-------------------- --------------------
Use the "Scheme" pulldown menu to change the active target to "Demo" and Use the "Scheme" pulldown menu to change the active target to "Demo" and
"My Mac 32-bit" or "My Mac 64-bit". Select "Build for" -> "Running"Run" from "My Mac 32-bit" or "My Mac 64-bit". Select "Build for" -> "Running"Run" from
the "Product" menu to create all libraries and test applications. the "Product" menu to create all libraries and test applications.
By default, the Xcode4 project builds applications that run under Mac OS X 10.5 and above. By default, the Xcode4 project builds applications that run under Mac OS X 10.5
To build applications that also run under older Mac OS versions, modify the "OS X Deployment and above. To build applications that also run under older Mac OS versions,
Target" item of the FLTK project build settings. modify the "OS X Deployment Target" item of the FLTK project build settings.
All frameworks and apps will be located in a private directory. Use All frameworks and apps will be located in a private directory. Use
"Window"->"Organizer" to find the full path. "Window"->"Organizer" to find the full path.
4.5 Testing FLTK 4.5 Testing FLTK
@@ -405,11 +407,11 @@ to explore all test programs.
Remove FLTK frameworks: Remove FLTK frameworks:
sudo rm -r /Library/Frameworks/fltk*.framework sudo rm -r /Library/Frameworks/fltk*.framework
Remove Fluid and possibly other utilities: Remove Fluid and possibly other utilities:
sudo rm -r /Applications/FLTK/ sudo rm -r /Applications/FLTK/
4.7 Installing FLTK 4.7 Installing FLTK
---------------------- ----------------------
@@ -418,17 +420,18 @@ When distributing FLTK applications, the FLTK frameworks should be made part of
the application package. For development however, it is very convenient to have the application package. For development however, it is very convenient to have
the Release-mode Frameworks in a standard location. the Release-mode Frameworks in a standard location.
For Xcode project template use, all FLTK frameworks should ibe built using For Xcode project template use, all FLTK frameworks should be built using
"Build for Archiving" and then copied from "Build for Archiving" and then copied from
"./(Organizer->Derived Data Path)/Release/" to "/Library/Frameworks/". The FLTK header files "./(Organizer->Derived Data Path)/Release/" to "/Library/Frameworks/".
for all FLTK frameworks will then be at "/Library/Frameworks/fltk.framework/ The FLTK header files for all FLTK frameworks will then be at
Headers/". Add this path to the header search path of your projects. "/Library/Frameworks/fltk.framework/Headers/". Add this path to the header
search path of your projects.
sudo rm -f -r /Library/Frameworks/fltk* sudo rm -f -r /Library/Frameworks/fltk*
sudo cp -R (Organizer->Derived Data Path)/Release/fltk*.framework /Library/Frameworks/ sudo cp -R (Organizer->Derived Data Path)/Release/fltk*.framework /Library/Frameworks/
Many FLTK applications will use Fluid, the FLTK User Interface builder, to Many FLTK applications will use Fluid, the FLTK User Interface builder, to
generate C++ source code from .fl resource files. Add Fluid to the developer generate C++ source code from .fl resource files. Add Fluid to the developer
tools: tools:
sudo mkdir /Applications/FLTK/ sudo mkdir /Applications/FLTK/
@@ -445,13 +448,13 @@ tools:
- Prepare an Info.plist file for your application derived from file - Prepare an Info.plist file for your application derived from file
test/editor-Info.plist which allows any file to be dropped test/editor-Info.plist which allows any file to be dropped
on the application icon. on the application icon.
You can edit this file in Xcode and change You can edit this file in Xcode and change
Document types/Item 0/CFBundleTypeExtensions/Item 0 Document types/Item 0/CFBundleTypeExtensions/Item 0
from the current "*" to the desired file extension. Use several items to declare from the current "*" to the desired file extension. Use several items to
several extensions. declare several extensions.
- Call fl_open_callback() at the beginning of your main() function that - Call fl_open_callback() at the beginning of your main() function that sets
sets what function will be called when a file is dropped on the application icon. what function will be called when a file is dropped on the application icon.
- In Xcode, set the "Info.plist File" build setting of your target application - In Xcode, set the "Info.plist File" build setting of your target application
to the Info.plist file you have prepared. to the Info.plist file you have prepared.
@@ -471,3 +474,4 @@ Apr 17 2012 - matt: added Xcode4 documentation
Nov 13 2012 - Manolo: added "MAKE AN APPLICATION LAUNCHABLE BY DROPPING FILES ON ITS ICON" Nov 13 2012 - Manolo: added "MAKE AN APPLICATION LAUNCHABLE BY DROPPING FILES ON ITS ICON"
Apr 28 2014 - Manolo: how to build programs that run on various Mac OS X versions Apr 28 2014 - Manolo: how to build programs that run on various Mac OS X versions
Mar 18 2015 - Manolo: removed uses of the Xcode3 project Mar 18 2015 - Manolo: removed uses of the Xcode3 project
Apr 01 2016 - AlbrechtS: corrected typo, formatted most line breaks < 80 columns