Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Integrate MSW, OS X and iOS build instructions into doxygen

Browse Source 
Make build instructions available in doxygen but keep the old
folder structure.
This commit is contained in:
Tobias Taschner
2018-10-03 18:11:54 +02:00
parent f4c7a31414
commit 1b5e3649e5
14 changed files with 438 additions and 393 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
docs/osx/install.txt → docs/osx/install.md
View File

@@ -1,58 +1,57 @@
wxWidgets for OS X installation
wxWidgets for OS X installation {#plat_osx_install}
-----------------------------------
[TOC]
wxWidgets can be compiled using Apple's Cocoa library.
Most OS X developers should start by downloading and installing Xcode
Most OS X developers should start by downloading and installing Xcode
from the App Store. It is a free IDE from Apple that provides
all of the tools you need for working with wxWidgets.
After Xcode is installed, download wxWidgets-{version}.tar.bz2 and then
After Xcode is installed, download wxWidgets-{version}.tar.bz2 and then
double-click on it to unpack it to create a wxWidgets directory.
Next use Terminal (under Applications, Utilities, Terminal) to access a command
prompt. Use cd to change directories to your wxWidgets directory and execute
Next use Terminal (under Applications, Utilities, Terminal) to access a command
prompt. Use cd to change directories to your wxWidgets directory and execute
the following sets of commands from the wxWidgets directory.
---------
mkdir build-cocoa-debug
cd build-cocoa-debug
../configure --enable-debug
make
mkdir build-cocoa-debug
cd build-cocoa-debug
../configure --enable-debug
make
# Build the samples and demos
cd samples; make;cd ..
cd demos; make;cd ..
Build the samples and demos
---------
cd samples; make;cd ..
cd demos; make;cd ..
After the compilation completes, use Finder to run the samples and demos
Go to build-cocoa-debug/samples to experiment with the Cocoa samples.
Go to build-cocoa-debug/demos to experiment with the Cocoa demos.
Double-click on the executables which have an icon showing three small squares.
The source code for the samples is in wxWidgets/samples
The source code for the demos is in wxWidgets/demos
---------
* Go to build-cocoa-debug/samples to experiment with the Cocoa samples.
* Go to build-cocoa-debug/demos to experiment with the Cocoa demos.
* Double-click on the executables which have an icon showing three small squares.
* The source code for the samples is in wxWidgets/samples
* The source code for the demos is in wxWidgets/demos
More information about building on OS X is available in the wxWiki.
Here are two useful links
https://wiki.wxwidgets.org/Guides_%26_Tutorials
https://wiki.wxwidgets.org/Development:_wxMac
* https://wiki.wxwidgets.org/Guides_%26_Tutorials
* https://wiki.wxwidgets.org/Development:_wxMac
---------
More advanced topics are covered below.
Advanced topics {#osx_advanced}
===============
---------
Installing library {#osx_install}
------------------
If you want to install the library into the system directories you'll need
to do this as root. The accepted way of running commands as root is to
use the built-in sudo mechanism. First of all, you must be using an
account marked as a "Computer Administrator". Then
6) sudo make install
7) type <YOUR OWN PASSWORD>
sudo make install
type \<YOUR OWN PASSWORD\>
Note that while using this method is okay for development, it is not
recommended that you require endusers to install wxWidgets into their
@@ -61,13 +60,13 @@ is to configure wxWidgets with --disable-shared. Another way to avoid
it is to make a framework for wxWidgets. Making frameworks is beyond
the scope of this document.
Note:
**Note:**
It is rarely desirable to install non-Apple software into system directories.
By configuring the library with --disable-shared and using the full path
to wx-config with the --in-place option you can avoid installing the library.
Apple Developer Tools: Xcode
Apple Developer Tools: Xcode {#osx_xcode}
----------------------------
You can use the project in build/osx/wxcocoa.xcodeproj to build the Cocoa
@@ -79,10 +78,10 @@ also wxrc tool which doesn't have its own Xcode project. If you need this tool,
the simplest possibility is to build it from the command line after installing
the libraries using commands like this:
$ cd utils/wxrc
$ g++ -o wxrc wxrc.cpp `wx-config --cxxflags --libs base,xml`
$ cd utils/wxrc
$ g++ -o wxrc wxrc.cpp `wx-config --cxxflags --libs base,xml`
Creating universal binaries
Creating universal binaries {#osx_universal_bin}
---------------------------
The Xcode projects for the wxWidgets library and minimal project are set up
@@ -108,11 +107,11 @@ binaries together. Assuming building on a PPC system:
2. Then, build for Intel, in a different folder. This time use:
export CFLAGS="-g -isysroot /Developer/SDKs/MacOSX10.7.sdk -arch i386"
export LDFLAGS="-syslibroot,/Developer/SDKs/MacOSX10.7.sdk"
export CFLAGS="-g -isysroot /Developer/SDKs/MacOSX10.7.sdk -arch i386"
export LDFLAGS="-syslibroot,/Developer/SDKs/MacOSX10.7.sdk"
./configure --disable-dependency-tracking --enable-static=yes --enable-shared=no \
--target=i386-apple-darwin8 --host=powerpc-apple-darwin8 --build=i386-apple-darwin8
./configure --disable-dependency-tracking --enable-static=yes --enable-shared=no \
--target=i386-apple-darwin8 --host=powerpc-apple-darwin8 --build=i386-apple-darwin8
You will need to reverse the powerpc and i386 parameters everywhere to build PPC on an Intel
machine.

4
docs/osx/readme.txt
View File

@@ -2,9 +2,9 @@ Welcome to wxWidgets/Mac
More Information is available from the wxWidgets project home page at
https://www.wxwidgets.org
https://www.wxwidgets.org
For more information, please see install.txt and the manuals.
For more information, please see install.md and the manuals.
Please send problems concerning installation, feature requests,
bug reports or comments to the wxWidgets users list. Information