Getting Started on Windows

If you read this offline, please visit the online version on http://www.yake.org for updated information.

The easiest way to acquire the sources is to grab a source package from the Downloads page. Alternatively, you can retrieve the sources from the Subversion repository: SVN Access.

Regardless how you acquire the sources you will have a directory tree like the following. The build directory is created through the build process.

The root path (…)) is often referred to as YAKE_ROOT in documentation and build scripts.

In order to compile Yake you need several dependencies.

Several prebuilt dependency packages are available on the Downloads page.

After downloading extract the package (with full paths) into the Yake root directory (YAKE_ROOT).

Before building Yake decide which toolset to use.

You can see available toolsets by opening a command shell in the Yake root directory (YAKE_ROOT) and entering: premake4 –help.

Here is a list of typical ones used on Windows:

After deciding which toolset to use, open the appropriate command shell for your compiler (for example, “Visual C++ 2008 Command Prompt”).

1. To create the build scripts: YAKE_ROOT> premake4 toolset
2. Open YAKE_ROOT\build\toolset\yake.sln in your Visual C++'s IDE
3. Select Build All

Optionally, you can put all the .lib and .dll files into a stage directory with YAKE_ROOT> premake4 stage.

1. Add the following paths to your program's include path setting: YAKE_ROOT, YAKE_ROOT\dependencies\boost
2. Add the following paths to your program's library path setting: YAKE_ROOT\build\stage or YAKE_ROOT\build\toolset\lib, and YAKE_ROOT\dependencies\boost\stage\lib.
3. If you compiler supports auto-linking then you can skip this step: Add the library file's name to your project's linker settings. For example, if you want to link to yake::base then add yake_base_d.lib to the Debug target and yake_base.lib to the Release target.

TIP: For the Visual C++ compiler Yake supports auto-linking, i.e. if you include a header of a Yake library then it automatically informs the compiler that it has to link to the Yake library .lib file.

See this tutorial for detailed steps on how to setup a project: setting_up_an_application_with_vc

Yake's libraries' names are defined using the following scheme:

1. prefix: yake_
2. library name: name_ (for example base or graphics)
3. compiler/toolset id: id_ (for example vc90 for Visual C++ 2008 (9.0))
4. target postfix: d for debug libraries, not postfix for release libraries
5. extension: .lib for import libraries, .dll for dynamic libraries

Examples:

• yake_base_vc90_d.lib
• yake_graphics_gcc.lib