Added a README file regarding WinRT support
authorDavid Ludwig <dludwig@pobox.com>
Wed, 09 Apr 2014 21:29:19 -0400
changeset 86980eed6a72e3c1
parent 8697 abf45e1abfe3
child 8699 aceb720ddd4b
Added a README file regarding WinRT support

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