doc: Update Windows build instructions

This commit is contained in:
Vojtech Kral 2019-01-03 19:33:57 +01:00
parent b66f41f43d
commit 02e1636831

View File

@ -1,99 +1,89 @@
### NOTE: This document is currently outdated wrt. the new post-Perl Slic3rPE. A new build process and the description thereof is a work in progress and is comming soon. Please stay tuned.
--
# Building Slic3r PE on Microsoft Windows # Building Slic3r PE on Microsoft Windows
The currently supported way of building Slic3r PE on Windows is with CMake and MS Visual Studio 2013 The currently supported way of building Slic3r PE on Windows is with CMake and MS Visual Studio 2013.
using our Perl binary distribution (compiled from official Perl sources).
You can use the free [Visual Studio 2013 Community Edition](https://www.visualstudio.com/vs/older-downloads/). You can use the free [Visual Studio 2013 Community Edition](https://www.visualstudio.com/vs/older-downloads/).
CMake installer can be downloaded from [the official website](https://cmake.org/download/). CMake installer can be downloaded from [the official website](https://cmake.org/download/).
Other setups (such as mingw + Strawberry Perl) _may_ work, but we cannot guarantee this will work Building with newer versions of MSVS (2015, 2017) may work too as reported by some of our users.
and cannot provide guidance.
### Dependencies
### Geting the dependencies On Windows Slic3r is built against statically built libraries.
We provide a prebuilt package of all the needed dependencies.
The package comes in a several variants:
First, download and upnack our Perl + wxWidgets binary distribution: - [64 bit, Release mode only](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=destdir-64.7z) (41 MB, 546 MB unpacked)
- [64 bit, Release and Debug mode](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=destdir-64-dev.7z) (88 MB, 1200 MB unpacked)
- [32 bit, Release mode only](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=destdir-32.7z) (38 MB, 391 MB unpacked)
- [32 bit, Release and Debug mode](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=destdir-32-dev.7z) (24 MB, 487 MB unpacked)
- 32 bit, release mode: [wperl32-5.24.0-2018-03-02.7z](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=wperl32-5.24.0-2018-03-02.7z) When unsure, use the _Release mode only_ variant, the _Release and Debug_ variant is only needed for debugging & developement.
- 64 bit, release mode: [wperl64-5.24.0-2018-03-02.7z](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=wperl64-5.24.0-2018-03-02.7z)
- 64 bit, release mode + debug symbols: [wperl64d-5.24.0-2018-03-02.7z](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=wperl64d-5.24.0-2018-03-02.7z)
It is recommended to unpack this package into `C:\`. If you're unsure where to unpack the package, unpack it into `C:\local\` (but it can really be anywhere).
Apart from wxWidgets and Perl, you will also need additional dependencies: Alternatively you can also compile the dependencies yourself, see below.
- Boost ### Building Slic3r PE with Visual Studio
- Intel TBB
- libcurl
We have prepared a binary package of the listed libraries: First obtain the Slic3 PE sources via either git or by extracting the source archive.
- 32 bit: [slic3r-destdir-32.7z](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=2%2Fslic3r-destdir-32.7z) Then you will need to note down the so-called 'prefix path' to the dependencies, this is the location of the dependencies packages + `\usr\local` appended.
- 64 bit: [slic3r-destdir-64.7z](https://bintray.com/vojtechkral/Slic3r-PE/download_file?file_path=2%2Fslic3r-destdir-64.7z) For example on 64 bits this would be `C:\local\destdir-64\usr\local`. The prefix path will need to be passed to CMake.
It is recommended you unpack this package into `C:\local\` as the environment When ready, open the relevant Visual Studio command line and `cd` into the directory with Slic3r sources.
setup script expects it there. Use these commands to prepare Visual Studio solution file:
Alternatively you can also compile the additional dependencies yourself.
There is a [powershell script](./deps-build/windows/slic3r-makedeps.ps1) which automates this process.
### Building Slic3r PE
Once the dependencies are set up in their respective locations,
go to the `wperl*` directory extracted earlier and launch the `cmdline.lnk` file
which opens a command line prompt with appropriate environment variables set up.
In this command line, `cd` into the directory with Slic3r sources
and use these commands to build the Slic3r from the command line:
perl Build.PL
perl Build.PL --gui
mkdir build mkdir build
cd build cd build
cmake .. -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release cmake .. -G "Visual Studio 12 Win64" -DCMAKE_PREFIX_PATH="<insert prefix path here>"
nmake
cd ..
perl slic3r.pl
The above commands use `nmake` Makefiles. Note that if you're building a 32-bit variant, you will need to change the `"Visual Studio 12 Win64"` to just `"Visual Studio 12"`.
You may also build Slic3r PE with other build tools:
Conversely, if you're using Visual Studio version other than 2013, the version number will need to be changed accordingly.
### Building with Visual Studio If `cmake` has finished without errors, go to the build directory and open the `Slic3r.sln` solution file in Visual Studio.
Before building, make sure you're building the right project (use one of those starting with `slic3r_app_...`) and that you're building
with the right configuration, ie. _Release_ vs. _Debug_. When unsure, choose _Release_.
Note that you won't be able to build a _Debug_ variant against a _Release_-only dependencies package.
To build and debug Slic3r PE with Visual Studio (64 bits), replace the `cmake` command with: TODO: Install paragraph from @supermerill (?), also credit
cmake .. -G "Visual Studio 12 Win64" -DCMAKE_CONFIGURATION_TYPES=RelWithDebInfo ### Building from the command line
For the 32-bit variant, use: There are several options for building from the command line:
cmake .. -G "Visual Studio 12" -DCMAKE_CONFIGURATION_TYPES=RelWithDebInfo - [msbuild](https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-reference?view=vs-2017&viewFallbackFrom=vs-2013)
- [Ninja](https://ninja-build.org/)
- [nmake](https://docs.microsoft.com/en-us/cpp/build/nmake-reference?view=vs-2017)
After `cmake` has finished, go to the build directory and open the `Slic3r.sln` solution file. To build with msbuild, use the same CMake command as in previous paragraph and then build using
This should open Visual Studio and load the Slic3r solution containing all the projects.
Make sure you use Visual Studio 2013 to open the solution.
You can then use the usual Visual Studio controls to build Slic3r (Hit `F5` to build and run with debugger). msbuild /P:Configuration=Release ALL_BUILD.vcxproj
If you want to run or debug Slic3r from within Visual Studio, make sure the `XS` project is activated.
It should be set as the Startup project by CMake by default, but you might want to check anyway.
There are multiple projects in the Slic3r solution, but only the `XS` project is configured with the right
commands to run and debug Slic3r.
The above cmake commands generate Visual Studio project files with the `RelWithDebInfo` configuration only. To build with Ninja or nmake, replace the `-G` option in the CMake call with `-G Ninja` or `-G "NMake Makefiles"`, respectively.
If you also want to use the `Release` configuration, you can generate Visual Studio projects with: Then use either `ninja` or `nmake` to start the build.
-DCMAKE_CONFIGURATION_TYPES=Release;RelWithDebInfo ### Building the dependencies package yourself
(The `Debug` configuration is not supported as of now.) The dependencies package is built using CMake scripts inside the `deps` subdirectory of Slic3r PE sources.
(This is intentionally not interconnected with the CMake scripts in the rest of the sources.)
### Building with ninja Open the preferred Visual Studio command line and `cd` into the directory with Slic3r sources.
Then `cd` into the `deps` directory and use these commands to build:
To use [Ninja](https://ninja-build.org/), replace the `cmake` and `nmake` commands with: mkdir build
cd build
cmake .. -G "Visual Studio 12 Win64" -DDESTDIR="C:\local\destdir-custom"
msbuild ALL_BUILD.vcxproj
cmake .. -G Ninja -DCMAKE_BUILD_TYPE=Release You can also use the Visual Studio GUI or other generators as mentioned above.
ninja
The `DESTDIR` option is the location where the bundle will be installed.
This may be customized. If you leave it empty, the `DESTDIR` will be places inside the same `build` directory.
Note that the build variant that you may choose using Visual Studio (ie. _Release_ or _Debug_ etc.) when building the dependency package is **not relevant**.
The dependency build will by default build _both_ the _Release_ and _Debug_ variants regardless of what you choose in Visual Studio.
You can disable building of the debug variant by passing the `-DDEP_DEBUG=OFF` option to CMake, this will only produce a _Release_ build.
Refer to the CMake scripts inside the `deps` directory to see which dependencies are built in what versions and how this is done.