docs/README-winrt.md
changeset 9025 d09d4b578e77
parent 9023 276802355854
child 9137 b0b056a7b932
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/README-winrt.md	Tue Jul 29 08:04:15 2014 -0700
     1.3 @@ -0,0 +1,44 @@
     1.4 +WinRT
     1.5 +================================================================================
     1.6 +
     1.7 +SDL/WinRT layer allows SDL2-based applications to run on many of Microsoft's
     1.8 +platforms that utilize the "Windows Runtime" (aka "WinRT") APIs.  WinRT apps
     1.9 +are currently always full-screen apps, run in what Microsoft calls their
    1.10 +"Modern" environment (aka. "Metro"), and are distributed via Microsoft-run
    1.11 +online stores.  Some of the operating systems that support such apps include:
    1.12 +
    1.13 +* Windows 8.x
    1.14 +* Windows RT 8.x (aka. Windows 8.x for ARM processors)
    1.15 +* Windows Phone 8.x
    1.16 +
    1.17 +To note, WinRT applications that run on Windows 8.x and/or Windows RT are often
    1.18 +called "Windows Store" apps.
    1.19 +
    1.20 +
    1.21 +--------------------------------------------------------------------------------
    1.22 +Requirements
    1.23 +--------------------------------------------------------------------------------
    1.24 +- Microsoft Visual C++ 2012 -- Free, "Express" editions may be used, so long
    1.25 +  as they include support for either "Windows Store" or "Windows Phone" apps.
    1.26 +  (NOTE: MSVC 2013 support is pending.  2012 projects may be converted to 2013
    1.27 +  projects by MSVC, in the meantime.)
    1.28 +- A valid Microsoft account -- This requirement is not imposed by SDL, but
    1.29 +  rather by Microsoft's Visual C++ toolchain.
    1.30 +
    1.31 +
    1.32 +--------------------------------------------------------------------------------
    1.33 +TODO
    1.34 +--------------------------------------------------------------------------------
    1.35 +- Finish adding support for MSVC 2013, and "Universal" WinRT apps, which
    1.36 +  support Windows 8.1, Windows Phone 8.1, and in the future, Xbox One and
    1.37 +  Windows Desktop.
    1.38 +- Finish adding support for the SDL satellite libraries (SDL_image, SDL_mixer,
    1.39 +  SDL_ttf, etc.)
    1.40 +- Create templates for both MSVC 2012 and MSVC 2013, and have the corresponding
    1.41 +  VSIX packages either include pre-built copies of SDL, or reference binaries
    1.42 +  available via MSVC's NuGet servers
    1.43 +- Write setup instructions that use MSVC 201x templates
    1.44 +- Write setup instructions that don't use MSVC 201x templates, and use
    1.45 +  MSVC project-to-project references, rather than pre-built binaries
    1.46 +- Write a list of caveats found in SDL/WinRT, such as APIs that don't work due
    1.47 +  to platform restrictions, or things that need further work