1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Sat Jun 22 10:43:12 2013 +0300
     1.3 @@ -0,0 +1,51 @@
     1.4 +D3DUT - Direct3D Utility Toolkit
     1.5 +--------------------------------
     1.6 +
     1.7 +
     1.8 +1. Overview
     1.9 +
    1.10 +D3DUT is for Direct3D 11, what GLUT is for OpenGL.
    1.11 +
    1.12 +In a nutshell, d3dut handles window creation, Direct3D setup, and event handling,
    1.13 +in an easy and intuitive way. The API is essentially identical to the GLUT API,
    1.14 +allowing you to create multiple D3D windows, and to set up per-window callback
    1.15 +functions for event delivery.
    1.16 +
    1.17 +Here is a short snippet that shows how to create a Direct3D 11 window and set up
    1.18 +event handlers with d3dut (a full example program is included under the example
    1.19 +subdirectory):
    1.20 +
    1.21 +	d3dut_init(&argc, argv);
    1.22 +	d3dut_init_window_size(800, 600);
    1.23 +	d3dut_init_display_mode(D3DUT_RGB | D3DUT_DEPTH | D3DUT_DOUBLE);
    1.24 +	d3dut_create_window("window title");
    1.25 +
    1.26 +	d3dut_display_func(display);
    1.27 +
    1.28 +	d3dut_main_loop();
    1.29 +
    1.30 +It's that simple, exactly like in GLUT: d3dut_main_loop handles all the event
    1.31 +processing, and calls your registered callbacks. After d3dut_create_window the
    1.32 +Direct3D device, context and swap chain are completely created and initialized
    1.33 +and you may start loading textures, creating vertex buffers, etc.
    1.34 +
    1.35 +
    1.36 +2. License
    1.37 +
    1.38 +Copyright (C) 2013 John Tsiombikas <nuclear@member.fsf.org>
    1.39 +D3DUT is free software. Feel free to use it, modify it, and redistribute it
    1.40 +under the terms of the GNU Lesser General Public License (LGPL) version 3, or
    1.41 +at your option any later version published by the Free Software Foundation.
    1.42 +
    1.43 +In simple words, this means that you can link with this library to use it
    1.44 +without any restrictions, for either free or proprietary programs, but if you
    1.45 +make any modifications and use them in any released program or derivative
    1.46 +library, you must release them under these exact same terms.
    1.47 +
    1.48 +See COPYING and COPYING.LESSER for the full license text.
    1.49 +
    1.50 +
    1.51 +3. Contact
    1.52 +
    1.53 +Feel free to contact me for any comments or suggestions, bug reports or patches,
    1.54 +through email at: nuclear@member.fsf.org.