summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChun-wei Fan <fanc999@yahoo.com.tw>2018-08-14 17:16:51 +0800
committerKjell Ahlstedt <kjellahlstedt@gmail.com>2018-09-10 15:16:53 +0200
commit3d6a83d52a2dfd57d2cdd203c38e7eb666d53f6d (patch)
tree0a7eadba43f177d28de530b6d40875248974e4b4
parent2a2f912533f26dcd774a6b771e13459b3ee86543 (diff)
downloadsigc++-3d6a83d52a2dfd57d2cdd203c38e7eb666d53f6d.tar.gz
build: Add a README.txt for Visual Studio builds
-rw-r--r--MSVC_NMake/README.txt48
-rw-r--r--MSVC_NMake/filelist.am1
2 files changed, 49 insertions, 0 deletions
diff --git a/MSVC_NMake/README.txt b/MSVC_NMake/README.txt
new file mode 100644
index 0000000..40d9a33
--- /dev/null
+++ b/MSVC_NMake/README.txt
@@ -0,0 +1,48 @@
+Instructions for building libsigc++ on Visual Studio
+====================================================
+Building the libsigc++ on Windows is now supported using Visual Studio
+versions 2017 or later in both 32-bit and 64-bit (x64) flavors,
+via NMake Makefiles. Due to C++-17 usage, Visual Studio 2015 or
+earlier is not supported, and any use of the headers installed with
+this package will require the use of the /std:c++17 compiler flag.
+
+libsigc++ itself has no external dependencies, but building the
+benchmark test program will require an installation of the Boost
+C++ libraries.
+
+The following describes what items are built with the following
+targets:
+
+-all (or no target specified): The libsigc++ DLL and the example programs.
+-test: The libsigc++ DLL and the test programs.
+-benchmark: The libsigc++ DLL and the benchmark program.
+
+The following are instructions for performing such a build. A 'clean' target is
+provided-it is recommended that one cleans the build and redo the build if any
+configuration option changed. An
+'install' target is also provided to copy the built items in their appropriate
+locations under $(PREFIX), which is described below.
+
+Invoke the build by issuing the command:
+nmake /f Makefile.vc CFG=[release|debug] [PREFIX=...] <option1=1 option2=1 ...>
+where:
+
+CFG: Required. Choose from a release or debug build. Note that
+ all builds generate a .pdb file for each .dll and .exe built--this refers
+ to the C/C++ runtime that the build uses.
+
+PREFIX: Optional. Base directory of where the third-party headers, libraries
+ and needed tools can be found, i.e. headers in $(PREFIX)\include,
+ libraries in $(PREFIX)\lib and tools in $(PREFIX)\bin. If not
+ specified, $(PREFIX) is set as $(srcroot)\..\vs$(X)\$(platform), where
+ $(platform) is win32 for 32-bit builds or x64 for 64-bit builds, and
+ $(X) is the short version of the Visual Studio used, as follows:
+ 2017: 15
+
+Explanation of options, set by <option>=1:
+------------------------------------------
+BOOST_DLL: When building the benchmark, link to a DLL build of the Boost
+ libraries. Required if your installation of the Boost libraries
+ are built as DLLs. Note that debug builds must link to debug
+ builds of Boost and release builds must link to releease builds
+ of Boost.
diff --git a/MSVC_NMake/filelist.am b/MSVC_NMake/filelist.am
index e3fb672..90cab7e 100644
--- a/MSVC_NMake/filelist.am
+++ b/MSVC_NMake/filelist.am
@@ -10,5 +10,6 @@ msvc_nmake_data = \
info-msvc.mak \
install.mak \
Makefile.vc \
+ README.txt \
sigc++config.h \
sigc.rc