Imported Upstream version 1.2.0
[platform/upstream/libzip.git] / vstudio / readme.txt
1 Building libzip with Microsoft Visual C++
2 =========================================
3 The script vsbuild.cmd can be used to build (and optionally test) libzip using
4 Microsoft Visual C++.
5
6 Prerequisites
7 -------------
8 Windows Server 2003 or Windows Vista or later (tested with Windows 7 x64)
9 Microsoft Visual Studio (tested with VS2013 Premium)
10 CMake (tested with version 3.3.1)
11 Source code for zlib (tested with version 1.2.8)
12
13 To run tests, you will also need:
14 Perl interpreter (tested with ActiveState ActivePerl 5.20.2 64-bit)
15 CPAN module IPC::Cmd (comes with ActivePerl)
16
17 You'll also need to make sure all of the above (specifically: msbuild.exe,
18 cmake.exe and perl.exe) are in your PATH at the time of running the script.
19
20 Unpacking zlib
21 --------------
22 Because libzip depends on zlib, the vsbuild.cmd script takes care of building
23 zlib for you as well. Download the source code from http://zlib.org/ and extract
24 all the files and subdirectories from the "zlib-x.y.z" directory into
25 vstudio/zlib.
26
27 Building libzip with Visual Studio 2013 for the impatient
28 ---------------------------------------------------------
29 1. Make sure all the prerequisites (see above) are installed and in your PATH.
30 2. Don't forget to unpack zlib (see "Unpacking zlib" above).
31 3. Open a Visual Studio Command Prompt in the "vstudio" directory (the directory
32    containing this file).
33 4. Enter the following command for a 32-bit x86 build:
34    vsbuild build "Visual Studio 12" v120
35    or for a 64-bit x64 build:
36    vsbuild build "Visual Studio 12 Win64" v120
37
38 If you'd like to run the tests as well, use one of the following commands:
39 vsbuild build+test "Visual Studio 12" v120
40 vsbuild build+test "Visual Studio 12 Win64" v120
41
42 Building libzip
43 ---------------
44 The script vsbuild.cmd has three modes of operation, with the following syntax:
45 vsbuild clean
46 vsbuild build <generator> <toolset>
47 vsbuild build+test <generator> <toolset>
48
49 "vsbuild clean" deletes all output and intermediate files and directories
50 generated by the build process.
51
52 "vsbuild build" just builds zlib and libzip and leaves the DLL files in the
53 following locations:
54 vstudio/zlib/installed/bin/zlib.dll
55 vstudio/zlib/installed/bin/zlibd.dll
56 build/lib/Debug/zip.dll
57 build/lib/Release/zip.dll
58
59 "vsbuild build+test" builds zlib and libzip as above, then runs the libzip
60 regression test suite.
61
62 The "build" and "build+test" commands require the following parameters:
63
64 <generator>: The CMake generator to use for project files. This identifies the
65 version of Visual Studio you're using, and also allows you to specify whether
66 the 32-bit or 64-bit of the libraries should be built.
67 I've tested "Visual Studio 12" (VS2013 x86) and "Visual Studio 12 Win64"
68 (VS2013 x64) but other versions should work as well. Run "cmake --help" for a
69 list of generators.
70
71 <toolset>: Specifies the platform toolset to use. Normally, this will match the
72 version of Visual Studio (e.g. "v120" for Visual Studio 2013 aka Visual Studio
73 12). See the Visual Studio documentation for more information about platform
74 toolsets.
75
76 Andrew Molyneux
77 andrew@molyneuxfamily.co.uk