Commit 7f1b833373cc0815d25fd2f3f6989bcc5f6942de
2021-02-14T16:48:29
initial work
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
diff --git a/VisualC.html b/VisualC.html
deleted file mode 100644
index 0631832..0000000
--- a/VisualC.html
+++ /dev/null
@@ -1,146 +0,0 @@
-<HTML>
- <HEAD>
- <TITLE>Using SDL with Microsoft Visual C++</TITLE>
- </HEAD>
- <BODY>
- <H1>
- Using SDL with Microsoft Visual C++
- </H1>
- <H3>
- by <A HREF="mailto:snowlion@sprynet.com">Lion Kimbro </A>and additions by <A HREF="mailto:james@conceptofzero.net">
- James Turk</A>
- </H3>
- <p>
- You can either use the precompiled libraries from <A HREF="http://www.libsdl.org/download.php"> the SDL Download web site </A>, or you can build SDL yourself.
- </p>
- <H3>
- Building SDL
- </H3>
- <P>
- Go into the VisualC directory and double-click on the Visual Studio solution for your version of Visual Studio, e.g. <CODE>SDL_VS2008.sln</CODE> This should open up the IDE.
- </P>
- <P>
- There are different solution files for the various
- versions of the IDE. Please use the appropriate version
- 2008, 2010, 2012 or 2013.
- </P>
- <P>
- Build the <CODE>.dll</CODE> and <CODE>.lib</CODE> files.
- </P>
- <P>
- This is done by right clicking on each project in turn (Projects are listed in
- the Workspace panel in the FileView tab), and selecting "Build".
- </P>
- <P>
- You may get a few warnings, but you should not get any errors. You do have to
- have at least the DirectX 9 SDK installed, however. The latest
- version of DirectX can be downloaded from <A HREF="http://www.microsoft.com">Microsoft</A>.
- </P>
- <P>
- Later, we will refer to the following .lib and .dll files that have just been
- generated:
- </P>
- <ul>
- <li> SDL2.dll</li>
- <li> SDL2.lib</li>
- <li> SDL2main.lib</li>
- </ul>
- <P>
- Search for these using the Windows Find (Windows-F) utility inside the VisualC directory.
- </P>
- <H3>
- Creating a Project with SDL
- </H3>
- <P>
- Create a project as a Win32 Application.
- </P>
- <P>
- Create a C++ file for your project.
- </P>
- <P>
- Set the C runtime to "Multi-threaded DLL" in the menu: <CODE>Project|Settings|C/C++
- tab|Code Generation|Runtime Library </CODE>.
- </P>
- <P>
- Add the SDL <CODE>include</CODE> directory to your list of includes in the
- menu: <CODE>Project|Settings|C/C++ tab|Preprocessor|Additional include directories </CODE>
- .
- <br>
- <STRONG><FONT color="#009900">VC7 Specific: Instead of doing this I find it easier to
- add the include and library directories to the list that VC7 keeps. Do this by
- selecting Tools|Options|Projects|VC++ Directories and under the "Show
- Directories For:" dropbox select "Include Files", and click the "New Directory
- Icon" and add the [SDLROOT]\include directory (e.g. If you installed to
- c:\SDL\ add c:\SDL\include). Proceed to change the
- dropbox selection to "Library Files" and add [SDLROOT]\lib.</FONT></STRONG>
- </P>
- <P>
- The "include directory" I am referring to is the <CODE>include</CODE> folder
- within the main SDL directory (the one that this HTML file located within).
- </P>
- <P>
- Now we're going to use the files that we had created earlier in the Build SDL
- step.
- </P>
- <P>
- Copy the following files into your Project directory:
- </P>
- <ul>
- <li> SDL2.dll</li>
- </ul>
- <P>
- Add the following files to your project (It is not necessary to copy them to
- your project directory):
- </P>
- <ul>
- <li> SDL2.lib </li>
- <li> SDL2main.lib</li>
- </ul>
- <P>
- (To add them to your project, right click on your project, and select "Add
- files to project")
- </P>
- <P><STRONG><FONT color="#009900">Instead of adding the files to your project it is more
- desirable to add them to the linker options: Project|Properties|Linker|Command
- Line and type the names of the libraries to link with in the "Additional
- Options:" box. Note: This must be done for each build
- configuration (e.g. Release,Debug).</FONT></STRONG></P>
- <H3>
- SDL 101, First Day of Class
- </H3>
- <P>
- Now create the basic body of your project. The body of your program should take
- the following form:
- <PRE><CODE>
-#include "SDL.h"
-
-int main( int argc, char* argv[] )
-{
- // Body of the program goes here.
- return 0;
-}
- </CODE></PRE>
- <P></P>
- <H3>
- That's it!
- </H3>
- <P>
- I hope that this document has helped you get through the most difficult part of
- using the SDL: installing it. Suggestions for improvements to this document
- should be sent to the writers of this document.
- </P>
- <P>
- Thanks to Paulus Esterhazy (pesterhazy@gmx.net), for the work on VC++ port.
- </P>
- <P>
- This document was originally called "VisualC.txt", and was written by <A HREF="mailto:slouken@libsdl.org">
- Sam Lantinga</A>.
- </P>
- <P>
- Later, it was converted to HTML and expanded into the document that you see
- today by <A HREF="mailto:snowlion@sprynet.com">Lion Kimbro</A>.
- </P>
- <P>Minor Fixes and Visual C++ 7 Information (In Green) was added by <A HREF="mailto:james@conceptofzero.net">James Turk</A>
- </P>
- </BODY>
-</HTML>
diff --git a/docs/README-visualc.md b/docs/README-visualc.md
new file mode 100644
index 0000000..ed5a479
--- /dev/null
+++ b/docs/README-visualc.md
@@ -0,0 +1,106 @@
+Using SDL with Microsoft Visual C++
+===================================
+
+### by [Lion Kimbro](mailto:snowlion@sprynet.com) with additions by [James Turk](mailto:james@conceptofzero.net)
+
+You can either use the precompiled libraries from the [SDL](https://www.libsdl.org/download.php) web site, or you can build SDL
+yourself.
+
+### Building SDL
+
+0. To build SDL, your machine must, at a minimum, have the DirectX9.0c SDK installed. It may or may not be retrievable from
+the [Microsoft](https://www.microsoft.com) website, so you might need to locate it [online](https://duckduckgo.com/?q=directx9.0c+sdk+download&t=h_&ia=web.
+_Editor's note: I've been able to successfully build SDL using Visual Studio 2019 without the DX9.0c SDK_
+
+1. Open the Visual Studio solution file at `./VisualC/SDL.sln`.
+
+2. Your IDE will likely prompt you to upgrade this solution file to whatever later version of the IDE you're using. In the `Retarget Projects` dialog,
+all of the affected project files should be checked allowing you to use the latest `Windows SDK Version` you have installed, along with
+the `Platform Toolset`.
+
+If you choose NOT to upgrade to use the latest `Windows SDK Version` or `Platform Toolset`, then you'll need the `Visual Studio 2010 Platform Toolset`.
+
+3. Build the `.dll` and `.lib` files by right clicking on each project in turn (Projects are listed in the _Workspace_
+panel in the _FileView_ tab), and selecting `Build`.
+
+You may get a few warnings, but you should not get any errors.
+
+Later, we will refer to the following `.lib` and `.dll` files that have just been generated:
+
+- `SDL2.dll`
+- `SDL2.lib`
+- `SDL2main.lib`
+
+Search for these using the Windows Find (Windows-F) utility inside the `VisualC` directory.
+
+### Creating a Project with SDL
+
+- Create a project as a `Win32 Application`.
+
+- Create a C++ file for your project.
+
+- Set the C runtime to `Multi-threaded DLL` in the menu:
+`Project|Settings|C/C++ tab|Code Generation|Runtime Library `.
+
+- Add the SDL `include` directory to your list of includes in the menu:
+`Project|Settings|C/C++ tab|Preprocessor|Additional include directories `
+
+ ** VC7 Specific: Instead of doing this, I find it easier to add the
+include and library directories to the list that VC7 keeps. Do this by
+selecting Tools|Options|Projects|VC++ Directories and under the "Show
+Directories For:" dropbox select "Include Files", and click the "New
+Directory Icon" and add the [SDLROOT]\\include directory (e.g. If you
+installed to c:\\SDL\\ add c:\\SDL\\include). Proceed to change the
+dropbox selection to "Library Files" and add [SDLROOT]\\lib.**
+
+The `include directory` I am referring to is the `include` folder within the main SDL directory (the one that this HTML file located within).
+
+Now we're going to use the files that we had created earlier in the Build SDL step.
+
+Copy the following file into your Project directory:
+
+- `SDL2.dll`
+
+Add the following files to your project (It is not necessary to copy them to your project directory):
+
+- `SDL2.lib`
+- `SDL2main.lib`
+
+To add them to your project, right click on your project, and select
+`Add files to project`.
+
+**Instead of adding the files to your project, it is more desirable to
+add them to the linker options: Project|Properties|Linker|Command Line
+and type the names of the libraries to link with in the "Additional
+Options:" box. Note: This must be done for each build configuration
+(e.g. Release,Debug).**
+
+### SDL 101, First Day of Class
+
+Now create the basic body of your project. The body of your program
+should take the following form:
+
+```
+ #include "SDL.h"
+
+ int main( int argc, char* argv[] )
+ {
+ // Body of the program goes here.
+ return 0;
+ }
+ ```
+
+### That's it!
+
+I hope that this document has helped you get through the most difficult part of using the SDL: installing it. Suggestions for improvements to
+this document should be sent to the writers of this document.
+
+### Credits
+
+Thanks to [Paulus Esterhazy](mailto:pesterhazy@gmx.net), for the work on VC++ port.
+
+This document was originally called "VisualC.txt", and was written by [Sam Lantinga](mailto:slouken@libsdl.org).
+
+Later, it was converted to HTML and expanded into the document that you see today by [Lion Kimbro](mailto:snowlion@sprynet.com).
+
+Minor Fixes and Visual C++ 7 Information (In Green) was added by [James Turk](mailto:james@conceptofzero.net)