SFML/tools/xcode/templates/readme.txt

XCODE 4 TEMPLATES
=================

These are templates to create easily a new SFML project in Xcode 4.

Features
--------

 * You can choose between command line tool or bundle application.
 * You can choose between using SFML libraries as dylibs or frameworks.
 * You can add independently each SFML module you'll use into your project.
 * A basic example is included automatically into your project's code.

Install
-------

If you are building SFML from sources you can set CMake's INSTALL_XCODE4_TEMPLATES variable to TRUE to install the templates automatically. Otherwise proceed as follow :
  1. Make sure "~/Library/Developer/Xcode/Templates/" folder exists;
  2. Copy "SFML" folder into the above folder.

Usage
-----

To use these templates follow these steps :

 1. open Xcode 4, 
 2. select "create a new Xcode project" from the "Welcome to Xcode" window or select menus File > New > New Project, 
 3. select "SFML" subsection under "Mac OS X",
 4. then select either "SFML Application" or "SFML Command Line Tool",
 5. fill in the requested information and you're done.

Question & Answer
-----------------

  * I would like to add/remove a module of SFML from my current project without creating a new one. How can I do that ?

    1. select your project from the project navigator panel,
    2. select your project's target on the main area,
    3. go to the "Build Settings" tab,
    4. go down to the bottom,
    5. set SFML_XXX variable, where XXX is the name of the module to add/remove to "$(SFML_LINK_PREFIX)sfml-XXX$(SFML_LINK_SUFFIX)" to add it or to "" (nothing) to remove it.


  * I changed my mind and would like to switch from dylibs to frameworks or vice versa. How can I do that ?

    1. select your project from the project navigator panel,
    2. select your project's target on the main area,
    3. go to the "Build Settings" tab,
    4. go down to the bottom,
    5. set SFML_BINARY_TYPE either to "DYLIBS" or "FRAMEWORKS".


  * How to use/don't use debug dylibs ?

    You can choose to use or not SFML debug binaries when creating a new project. However, if you have already created your project you can do the following :

    1. select your project from the project navigator panel,
    2. select your project's target on the main area,
    3. go to the "Build Settings" tab,
    4. go down to the bottom,
    5. set SFML_LINK_DYLIBS_SUFFIX_DEBUG to "-d" to use them or to "" (empty string) to use only release binary.


  * I want to use the static version of SFML. Is it possible ?

    Short answer : Don't do that!

    We strongly recommend you to use either dylibs or frameworks on Mac OS X. Please refer to Apple documentation for information about static vs shared libraries debate.

    If you really need/want to use static libraries proceed as follow. First, set your project to use dylibs (see above Q & A). Then set SFML_LINK_DYLIBS_SUFFIX to "-s-d" in debug mode and to "-s" in release mode. Finally, remove the script automatically generated by the application template (see Build Phases tab).