DXGL r630 - Code Review

Jump to navigation Jump to search
Repository:DXGL
Revision:r629‎ | r630 | r631 >
Date:01:39, 30 December 2015
Author:admin
Status:new
Tags:
Comment:
Rename ReadMe.txt to ReadMe.md and update installer
Modified paths:

Diff [purge]

Index: ReadMe.txt
@@ -1,79 +0,0 @@
2 -# DXGL 0.5.7
3 -http://www.williamfeely.info/wiki/DXGL
4 -
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.
7 -
8 -## GitHub Notice
9 -If you downloaded DXGL from GitHub, please note that the version number will not work.
10 -
11 -## System Requirements
12 -
13 -* Windows XP SP3, Vista, 7, 8, 8.1, or 10 (May work under recent versions of Wine)
14 -* OpenGL 2.0 or higher compatible video card, with hardware accelerated non-power-of-two size textures
15 - * OpenGL 3.2 or higher recommended.
16 -* Visual C++ 2010 x86 runtime, available at http://www.microsoft.com/download/en/details.aspx?id=5555 (will be installed if not present)
17 -
18 -## Build Requirements
19 -* Visual Studio 2013, either full version or Express for Windows Desktop might work.
20 -* 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)
24 -
25 -## Build Instructions
26 -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 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.
29 -
30 -## Progress
31 -For detailed progress information, please check http://www.williamfeely.info/wiki/DXGL_Features
32 -What works:
33 -* DirectDraw object creation and destruction (versions 1 to 7)
34 -* Display mode enumeration and switching (with emulated mode switching)
35 -* Fullscreen and windowed modes.
36 -* Basic Blt() functionality
37 -* 8-bit color emulated with GLSL shader
38 -
39 -What partially works:
40 -* 3D graphics are only partially supported.
41 -
42 -What doesn't work:
43 -* Many functions are stubbed out and return an error
44 -
45 -## Installation
46 -
47 -Run the installer. When the installer completes, open DXGL Config and add your program files to the config program.
48 -To uninstall, go to the Add/Remove Programs or Programs and Features control panel and uninstall.
49 -
50 -## SVN
51 -
52 -SVN readonly access is available at:
53 -https://www.dxgl.info/svn/dxgl/
54 -
55 -There is a Mediawiki-based SVN log at:
56 -http://www.williamfeely.info/wiki/Special:Code/DXGL
57 -
58 -## AppDB
59 -
60 -An AppDB system (similar to that on winehq.org) is now available at:
61 -https://www.williamfeely.info/appdb/
62 -
63 -This requires a user account separate from the other services.
64 -
65 -Please note that the AppDB is now deprecated and will be made read-only once the new DXGL Wiki launches.
66 -
67 -## Discussion boards
68 -
69 -You may discuss DXGL at:
70 -https://www.dxgl.info/phpBB3
71 -
72 -You must create a forum account to post content.
73 -
74 -
75 -## Bug reports
76 -
77 -Bug reports are managed by a Bugzilla system available at:
78 -https://www.williamfeely.info/bugzilla
79 -
80 -A user account needs to be created at this site to post bug reports.
Index: Installer/dxgl.nsi
@@ -59,7 +59,7 @@
6060 ; Finish page
6161 !define MUI_FINISHPAGE_RUN "$INSTDIR\dxglcfg.exe"
6262 !define MUI_FINISHPAGE_RUN_TEXT "Configure DXGL"
63 -!define MUI_FINISHPAGE_SHOWREADME "$INSTDIR\ReadMe.txt"
 63+!define MUI_FINISHPAGE_SHOWREADME "$SYSDIR\notepad.exe $INSTDIR\ReadMe.md"
6464 !insertmacro MUI_PAGE_FINISH
6565
6666 ; Uninstaller pages
@@ -118,7 +118,7 @@
119119 File "..\${SRCDIR}\dxglcfg.exe"
120120 CreateShortCut "$SMPROGRAMS\DXGL\Configure DXGL.lnk" "$INSTDIR\dxglcfg.exe"
121121 File "..\${SRCDIR}\ddraw.dll"
122 - File "..\ReadMe.txt"
 122+ File "..\ReadMe.md"
123123 File "..\COPYING.txt"
124124 File "..\Help\dxgl.chm"
125125 CreateShortCut "$SMPROGRAMS\DXGL\DXGL Help.lnk" "$INSTDIR\dxgl.chm"
@@ -318,7 +318,7 @@
319319 Delete "$INSTDIR\${PRODUCT_NAME}.url"
320320 Delete "$INSTDIR\uninst.exe"
321321 Delete "$INSTDIR\COPYING.txt"
322 - Delete "$INSTDIR\ReadMe.txt"
 322+ Delete "$INSTDIR\ReadMe.md"
323323 Delete "$INSTDIR\ddraw.dll"
324324 Delete "$INSTDIR\dxglcfg.exe"
325325 Delete "$INSTDIR\dxgltest.exe"
Index: ReadMe.md
@@ -0,0 +1,79 @@
 2+# DXGL 0.5.7
 3+http://www.williamfeely.info/wiki/DXGL
 4+
 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.
 7+
 8+## GitHub Notice
 9+If you downloaded DXGL from GitHub, please note that the version number will not work.
 10+
 11+## System Requirements
 12+
 13+* Windows XP SP3, Vista, 7, 8, 8.1, or 10 (May work under recent versions of Wine)
 14+* OpenGL 2.0 or higher compatible video card, with hardware accelerated non-power-of-two size textures
 15+ * OpenGL 3.2 or higher recommended.
 16+* Visual C++ 2010 x86 runtime, available at http://www.microsoft.com/download/en/details.aspx?id=5555 (will be installed if not present)
 17+
 18+## Build Requirements
 19+* Visual Studio 2013, either full version or Express for Windows Desktop might work.
 20+* 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)
 24+
 25+## Build Instructions
 26+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 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.
 29+
 30+## Progress
 31+For detailed progress information, please check http://www.williamfeely.info/wiki/DXGL_Features
 32+What works:
 33+* DirectDraw object creation and destruction (versions 1 to 7)
 34+* Display mode enumeration and switching (with emulated mode switching)
 35+* Fullscreen and windowed modes.
 36+* Basic Blt() functionality
 37+* 8-bit color emulated with GLSL shader
 38+
 39+What partially works:
 40+* 3D graphics are only partially supported.
 41+
 42+What doesn't work:
 43+* Many functions are stubbed out and return an error
 44+
 45+## Installation
 46+
 47+Run the installer. When the installer completes, open DXGL Config and add your program files to the config program.
 48+To uninstall, go to the Add/Remove Programs or Programs and Features control panel and uninstall.
 49+
 50+## SVN
 51+
 52+SVN readonly access is available at:
 53+https://www.dxgl.info/svn/dxgl/
 54+
 55+There is a Mediawiki-based SVN log at:
 56+http://www.williamfeely.info/wiki/Special:Code/DXGL
 57+
 58+## AppDB
 59+
 60+An AppDB system (similar to that on winehq.org) is now available at:
 61+https://www.williamfeely.info/appdb/
 62+
 63+This requires a user account separate from the other services.
 64+
 65+Please note that the AppDB is now deprecated and will be made read-only once the new DXGL Wiki launches.
 66+
 67+## Discussion boards
 68+
 69+You may discuss DXGL at:
 70+https://www.dxgl.info/phpBB3
 71+
 72+You must create a forum account to post content.
 73+
 74+
 75+## Bug reports
 76+
 77+Bug reports are managed by a Bugzilla system available at:
 78+https://www.williamfeely.info/bugzilla
 79+
 80+A user account needs to be created at this site to post bug reports.