Skip to content

Commit 50f52fb

Browse files
Denver MillerDenverM80
authored andcommitted
Fix included files in packaged SDK distro; update README
1 parent c2d89b7 commit 50f52fb

File tree

3 files changed

+30
-32
lines changed

3 files changed

+30
-32
lines changed

win32/README.md

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,42 @@ Overview
22
--------
33

44
This directory contains all of the files needed to build under Windows.
5-
Currently we build using cmake and MSVC 2015 and above.
5+
Currently we build using CMake and MSVC 2015 and above.
66

77
Prerequisites
88
-------------
99

1010
1. Boost C++ library installed to a default location on the machine
11+
2. PowerShell 3+
12+
3. If you don't already have 7zip, it will be downloaded and placed in the Windows Temp directory to untar glib.
1113

14+
Dependencies
15+
------------
16+
17+
The SDK depends upon several open source libraries.
18+
19+
To acquire the dependencies, follow the following procedure:
20+
21+
1. Ensure the built dependency directory at `/win32/deps/install` is empty.
22+
2. Download and extract the dependency library packages. Depending on whether you want 32 or 64 bit libs, run one of the following:
23+
* `\win32\deps\build\download_and_unzip.bat`
24+
* `\win32\deps\build\download_and_unzip_64.bat`
25+
* You can also manually download the URLs and extract using whatever utility you like. Note that the glib package must be extracted to `/win32/deps/build/prebuilt`.
26+
3. The Windows batch file `/win32/deps/install(_64).bat` compiles and installs the dependencies into the `/win32/deps/install` directory. It executes the Visual Studio 14 2015 Command Prompt environment script, so if you're using a different version you'll have to modify the Visual Studio install path inside of `install(_64).bat`.
1227

13-
Basic Build
28+
29+
Build
1430
-----------
1531

1632
To build the client library
1733

1834

1935
1. Open a new Visual Studio Command Prompt.
20-
2. Navigate to the ds3_c_sdk directory.
21-
3. Run the following command: `cmake -G "Visual Studio 14 2015"`
22-
4. Either open the resulting 'libds3.sln' in Visual Studio and build it from
23-
there, or run the command 'msbuild libds3.sln' from the command prompt.
36+
2. Navigate to the ds3_c_sdk\win32 directory.
37+
3. Run `package(_64).bat`, which will use CMake to create a Visual Studio 14 2015 solution, and then compile from the command line using msbuild, and compress all requiredSDK dependencies into a `ds3_win(32 or 64).zip`
38+
3. Run the following command: `cmake .. -G "Visual Studio 14 2015 {Win64}"`
39+
4. Either open the resulting `libds3.sln` in Visual Studio and build it from
40+
there, or run the command `msbuild libds3.sln` from the command prompt.
2441
This should build the libds3 library, which is placed in the directory '<root of repo>/win32/output/bin'
2542

2643

@@ -29,31 +46,10 @@ Unit Tests
2946

3047
1. Open a new Visual Studio Command Prompt.
3148
2. Navigate to the ds3_c_sdk/test directory.
32-
3. Run the following command: `cmake -G "Visual Studio 14 2015"`
49+
3. Run the following command: `cmake ..\.. -G "Visual Studio 14 2015 {Win64}"`
3350
4. Either open the resulting 'libds3_tests.sln' in Visual Studio and build it
3451
from there, or run the command 'msbuild libds3_tests.sln' from the command
3552
prompt. This should build the libds3 library, which is placed in the directory
3653
'<root of repo>/tests/bin'
3754

3855

39-
Dependencies
40-
------------
41-
42-
The SDK depends upon several open source libraries. For convenience we
43-
redistribute these dependencies in the `/win32/deps/install` directory,
44-
except for the Boost library headers.
45-
46-
To re-build the dependencies, follow the following procedure:
47-
48-
1. Delete the built dependency directory at `/win32/deps/install`.
49-
2. Download and extract the dependency library packages.
50-
* The Unix shell script at `/win32/deps/build/download_and_unzip.sh` can do
51-
this for you, but you don't strictly need to use it. You can also manually
52-
download the URLs and extract using whatever utility you like. Note that
53-
the glib package must be extracted to `/win32/deps/build/prebuilt`.
54-
3. The Windows batch file `/win32/deps/install.bat` compiles and installs the
55-
dependencies into the `/win32/deps/install` directory. It executes the
56-
Visual Studio 2012 Command Prompt environment script, so if you're using a
57-
different version you'll have to modify the Visual Studio install path inside
58-
of `install.bat`.
59-

win32/run_package_dot_bat_instead.ps1

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ msbuild libds3.sln
44

55
# Copy dependencies into output directory
66
Copy-Item -Path deps\install\* -Destination output -Recurse -force
7+
Copy-Item -Path ..\src\*.h -Exclude ds3_request.h,ds3_net.h,ds3_utils.h,ds3_string_multimap_impl.h,ds3_connection.h -Destination output\include -force
78

89
# Create a zip file with the application contents.
910
[Reflection.Assembly]::LoadWithPartialName("System.IO.Compression.FileSystem")
1011
[System.IO.Compression.ZipFile]::CreateFromDirectory(
1112
"ds3",
12-
"ds3.zip",
13+
"ds3_win32.zip",
1314
[System.IO.Compression.CompressionLevel]::Optimal,
14-
$true
15+
$false
1516
)
1617

1718
# Delete the build.

win32/run_package_dot_bat_instead_64.ps1

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ msbuild libds3.sln
44

55
# Copy dependencies into output directory
66
Copy-Item -Path deps\install\* -Destination output -Recurse -force
7+
Copy-Item -Path ..\src\*.h -Exclude ds3_request.h,ds3_net.h,ds3_utils.h,ds3_string_multimap_impl.h,ds3_connection.h -Destination output\include -force
78

89
# Create a zip file with the application contents.
910
[Reflection.Assembly]::LoadWithPartialName("System.IO.Compression.FileSystem")
1011
[System.IO.Compression.ZipFile]::CreateFromDirectory(
1112
"output",
12-
"ds3_x64.zip",
13+
"ds3_win64.zip",
1314
[System.IO.Compression.CompressionLevel]::Optimal,
14-
$true
15+
$false
1516
)
1617

1718
# Delete the build.

0 commit comments

Comments
 (0)