From 2c3f0e9dfae3fa6a785a53f016a1284d34288583 Mon Sep 17 00:00:00 2001 From: octaspire Date: Tue, 29 Jan 2019 23:44:04 +0200 Subject: [PATCH] Update documentation * Update build instructions for Microsoft Windows using MSVC. The previous .bat file is replaced with a python script that will download, extract and set up all the headers and libraries needed for building Dern plugins in Windows (for example SDL2, SDL2_image, SDL2_ttf, SDL2_mixer, PDCurses). Sadly, this adds Python 2.7.x as a tool dependency for Windows, but it makes building Dern in Windows _much_ easier. In most other systems the required libraries can be installed simply and quickly by giving a short command, but in Windows the number of steps required is quite overwhelming. So instead of printing user lines and lines of instructions on how to download required headers and libraries, extract them, copy some files, generate .lib files, and so on, we just do it using python; the script does everything and the user doesn't have to do anything. --- dev/doc/book/dern-manual.htm | 22 ++++++++++++++--- dev/doc/book/examples/sh/windows-msvc.bat | 2 +- .../octaspire/dern/octaspire_dern_config.h | 2 +- release/documentation/dern-manual.html | 24 +++++++++++++++---- release/octaspire-dern-amalgamated.c | 2 +- 5 files changed, 42 insertions(+), 10 deletions(-) diff --git a/dev/doc/book/dern-manual.htm b/dev/doc/book/dern-manual.htm index 2dc20e5..5835532 100644 --- a/dev/doc/book/dern-manual.htm +++ b/dev/doc/book/dern-manual.htm @@ -525,11 +525,12 @@ in the Command Prompt window (NOT in the Git Bash window).

-

Windows using MSVC and Git

+

Windows using MSVC, Python 2.7 and Git

- Download and install Visual Studio 2017 (Community edition) and - Git. + Download and install Visual Studio 2017 (Community edition), + Git and Python 2.7.x. The installation script + is tested with python version 2.7.15.

@@ -549,6 +550,21 @@ .INCLUDE: dev/doc/book/examples/sh/windows-msvc.bat +

+ Please note, that you might have to change the path + for the python executable in the instructions above; + depending where you installed it. + Or, if the python executable can be found from PATH, + you can leave the path out. +

+ +

+ The python script will download, extract and set up all the + libraries that are needed for Dern plugins. Then it will + build all the Dern programs, plugins and examples and will give + you a summary how to run or test them. +

+

ReactOS

diff --git a/dev/doc/book/examples/sh/windows-msvc.bat b/dev/doc/book/examples/sh/windows-msvc.bat index 36d0912..f070c1e 100644 --- a/dev/doc/book/examples/sh/windows-msvc.bat +++ b/dev/doc/book/examples/sh/windows-msvc.bat @@ -1,4 +1,4 @@ cd c:\ git clone https://github.com/octaspire/dern.git cd dern\release -how-to-build\windows-msvc.bat +C:\Python27\python.exe how-to-build\windows-msvc.py diff --git a/dev/include/octaspire/dern/octaspire_dern_config.h b/dev/include/octaspire/dern/octaspire_dern_config.h index bf3e695..971b77b 100644 --- a/dev/include/octaspire/dern/octaspire_dern_config.h +++ b/dev/include/octaspire/dern/octaspire_dern_config.h @@ -18,7 +18,7 @@ limitations under the License. #define OCTASPIRE_DERN_CONFIG_H #define OCTASPIRE_DERN_CONFIG_VERSION_MAJOR "0" -#define OCTASPIRE_DERN_CONFIG_VERSION_MINOR "484" +#define OCTASPIRE_DERN_CONFIG_VERSION_MINOR "485" #define OCTASPIRE_DERN_CONFIG_VERSION_PATCH "0" #define OCTASPIRE_DERN_CONFIG_VERSION_STR "Octaspire Dern version " \ diff --git a/release/documentation/dern-manual.html b/release/documentation/dern-manual.html index 4dca685..e21e38b 100644 --- a/release/documentation/dern-manual.html +++ b/release/documentation/dern-manual.html @@ -587,11 +587,12 @@ http://www.gnu.org/software/src-highlite --> in the Command Prompt window (NOT in the Git Bash window).

-

2.5 Windows using MSVC and Git

+

2.5 Windows using MSVC, Python 2.7 and Git

- Download and install Visual Studio 2017 (Community edition) and - Git. + Download and install Visual Studio 2017 (Community edition), + Git and Python 2.7.x. The installation script + is tested with python version 2.7.15.

@@ -616,9 +617,24 @@ http://www.gnu.org/software/src-highlite --> 

cd c:\
 git clone https://github.com/octaspire/dern.git
 cd dern\release
-how-to-build\windows-msvc.bat
+C:\Python27\python.exe how-to-build\windows-msvc.py
+

+ Please note, that you might have to change the path + for the python executable in the instructions above; + depending where you installed it. + Or, if the python executable can be found from PATH, + you can leave the path out. +

+ +

+ The python script will download, extract and set up all the + libraries that are needed for Dern plugins. Then it will + build all the Dern programs, plugins and examples and will give + you a summary how to run or test them. +

+

2.6 ReactOS

diff --git a/release/octaspire-dern-amalgamated.c b/release/octaspire-dern-amalgamated.c index 84e2a48..2ca2255 100644 --- a/release/octaspire-dern-amalgamated.c +++ b/release/octaspire-dern-amalgamated.c @@ -26336,7 +26336,7 @@ limitations under the License. #define OCTASPIRE_DERN_CONFIG_H #define OCTASPIRE_DERN_CONFIG_VERSION_MAJOR "0" -#define OCTASPIRE_DERN_CONFIG_VERSION_MINOR "484" +#define OCTASPIRE_DERN_CONFIG_VERSION_MINOR "485" #define OCTASPIRE_DERN_CONFIG_VERSION_PATCH "0" #define OCTASPIRE_DERN_CONFIG_VERSION_STR "Octaspire Dern version " \ -- 2.45.2