DXGL r629 - Code Review

Jump to navigation Jump to search
Repository:DXGL
Revision:r628‎ | r629 | r630 >
Date:01:30, 30 December 2015
Author:admin
Status:new
Tags:
Comment:
Convert readme.txt to Markdown format.
Update some URLs in readme.txt
Modified paths:

Diff [purge]

Index: ReadMe.txt
@@ -1,32 +1,32 @@
2 -DXGL 0.5.7
 2+# DXGL 0.5.7
33 http://www.williamfeely.info/wiki/DXGL
44
5 -== Introduction ==
 5+## Introduction
 6+DXGL is a free replacement for the Windows ddraw.dll library, running on OpenGL. It is designed to overcome driver bugs, particularly in Windows Vista and newer operating systems. It also adds various enhancements to the graphics output such as display scaling and filtering options. DXGL supports the DirectX 7.0 graphics APIs, however it is currently under development and does not work with many programs.
67
7 -DXGL is a project to create a DirectDraw/Direct3D version 1 to 7 implementation that runs on OpenGL. It is intended to alleviate some of the graphics glitches inherent with using legacy DirectX interfaces on modern video cards. The API will be 100% binary compatible with the system ddraw.dll file.
 8+## GitHub Notice
 9+If you downloaded DXGL from GitHub, please note that the version number will not work.
810
9 -DXGL is currently in an alpha stage, but several applications and games already work.
 11+## System Requirements
1012
11 -== System Requirements ==
12 -
13 -* Windows XP, Vista, 7, 8, 8.1, or 10 (May work under recent builds of Wine)
 13+* Windows XP SP3, Vista, 7, 8, 8.1, or 10 (May work under recent versions of Wine)
1414 * OpenGL 2.0 or higher compatible video card, with hardware accelerated non-power-of-two size textures
15 -** OpenGL 3.2 or higher recommended.
 15+ * OpenGL 3.2 or higher recommended.
1616 * Visual C++ 2010 x86 runtime, available at http://www.microsoft.com/download/en/details.aspx?id=5555 (will be installed if not present)
1717
18 -== Build Requirements ==
19 -* Visual Studio 2010 or Visual C++ 2010 Express
 18+## Build Requirements
 19+* Visual Studio 2013, either full version or Express for Windows Desktop might work.
2020 * The following components are optional. The build process will ask for these if they do not exist:
21 -** TortoiseSVN (to fill in revision on SVN builds)
22 -** HTML Help Workshop (to build help)
23 -** NSIS (to build installer, requires TortoiseSVN and HTML Help Workshop to succeed)
 21+ * TortoiseSVN (to fill in revision on SVN builds)
 22+ * HTML Help Workshop (to build help)
 23+ * NSIS (to build installer, requires TortoiseSVN and HTML Help Workshop to succeed)
2424
25 -== Build Instructions ==
 25+## Build Instructions
2626 These instructions assume that you do not have any of the required software installed. If you already have any or all of this software installed and set up, skip those steps.
27 -* Install Visual C++ 2010 Express at http://www.microsoft.com/express/downloads/#2010-Visual-CPP .
28 -* Open the dxgl.sln file, select your build configuration (Debug or Release) in the toolbar, and press F7.
 27+* Install Visual Studio 2013 Community at https://www.visualstudio.com/en-us/news/vs2013-community-vs.aspx
 28+* Open the dxgl.sln file, select your build configuration (Debug or Release) in the toolbar, and press F7 to build.
2929
30 -== Progress ==
 30+## Progress
3131 For detailed progress information, please check http://www.williamfeely.info/wiki/DXGL_Features
3232 What works:
3333 * DirectDraw object creation and destruction (versions 1 to 7)
@@ -41,20 +41,20 @@
4242 What doesn't work:
4343 * Many functions are stubbed out and return an error
4444
45 -== Installation ==
 45+## Installation
4646
4747 Run the installer. When the installer completes, open DXGL Config and add your program files to the config program.
4848 To uninstall, go to the Add/Remove Programs or Programs and Features control panel and uninstall.
4949
50 -== SVN ==
 50+## SVN
5151
5252 SVN readonly access is available at:
53 -svn://www.williamfeely.info/dxgl
 53+https://www.dxgl.info/svn/dxgl/
5454
5555 There is a Mediawiki-based SVN log at:
5656 http://www.williamfeely.info/wiki/Special:Code/DXGL
5757
58 -== AppDB ==
 58+## AppDB
5959
6060 An AppDB system (similar to that on winehq.org) is now available at:
6161 https://www.williamfeely.info/appdb/
@@ -61,15 +61,17 @@
6262
6363 This requires a user account separate from the other services.
6464
65 -== Discussion boards ==
 65+Please note that the AppDB is now deprecated and will be made read-only once the new DXGL Wiki launches.
6666
 67+## Discussion boards
 68+
6769 You may discuss DXGL at:
68 -https://www.williamfeely.info/phpBB3
 70+https://www.dxgl.info/phpBB3
6971
7072 You must create a forum account to post content.
7173
7274
73 -== Bug reports ==
 75+## Bug reports
7476
7577 Bug reports are managed by a Bugzilla system available at:
7678 https://www.williamfeely.info/bugzilla