Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/supermerill/SuperSlicer.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorremi durand <remi-j.durand@thalesgroup.com>2021-04-12 03:15:39 +0300
committerremi durand <remi-j.durand@thalesgroup.com>2021-04-18 16:32:28 +0300
commite9f4a0205b0ca08d60c84bfac94145b7eee480f2 (patch)
treed3764ce8f6a9d8096b5b6515539256dd7ec2c27e /doc
parent6f99e220e57b03cd60cbe56d09e2237e9a1a89ec (diff)
fix renaming, build & doc
Diffstat (limited to 'doc')
-rw-r--r--doc/How to build - Linux et al.md46
-rw-r--r--doc/How to build - Mac OS.md39
-rw-r--r--doc/How to build - Windows.md44
3 files changed, 85 insertions, 44 deletions
diff --git a/doc/How to build - Linux et al.md b/doc/How to build - Linux et al.md
index d30001163..97e3e5e3d 100644
--- a/doc/How to build - Linux et al.md
+++ b/doc/How to build - Linux et al.md
@@ -1,13 +1,13 @@
-# Building SuperSlicer on UNIX/Linux
+# Building Slic3r on UNIX/Linux
-SuperSlicer uses the CMake build system and requires several dependencies.
+Slic3r uses the CMake build system and requires several dependencies.
The dependencies can be listed in `deps/deps-linux.cmake` and `deps/deps-unix-common.cmake`, although they don't necessarily need to be as recent
as the versions listed - generally versions available on conservative Linux distros such as Debian stable or CentOS should suffice.
-Perl is not required any more.
+Perl is not required anymore.
-In a typical situation, one would open a command line, go to the SuperSlicer sources, create a directory called `build` or similar,
+In a typical situation, one would open a command line, go to the Slic3r sources, create a directory called `build` or similar,
`cd` into it and call:
cmake ..
@@ -17,9 +17,23 @@ where `N` is the number of CPU cores available.
Additional CMake flags may be applicable as explained below.
+### How to get the source code
+
+You have to gitclone the repository
+```
+git clone https://github.com/slic3r/Slic3r.git
+```
+
+and then you have to clone the profiles submodules
+
+```
+cd resources/profiles
+git submodule update
+```
+
## How to build, the easy way
-You can follow the [script](https://github.com/supermerill/SuperSlicer/blob/master/.github/workflows/ccpp_ubuntu.yml) the build server use to create the ubuntu release.
+You can follow the [script](https://github.com/supermerill/Slic3r/blob/master/.github/workflows/ccpp_ubuntu.yml) the build server use to create the ubuntu release.
You have to execute each command at the right of the 'run: ' tags, in the directory that is at the right of the previous 'working-directory:' tag.
@@ -29,13 +43,13 @@ You can stop after the `make slic3r` as the rest of the commands are for buildin
### Dependency resolution
-By default SuperSlicer looks for dependencies the default way CMake looks for them, i.e. in default system locations.
-On Linux this will typically make SuperSlicer depend on dynamically loaded libraries from the system, however, SuperSlicer can be told
+By default Slic3r looks for dependencies the default way CMake looks for them, i.e. in default system locations.
+On Linux this will typically make Slic3r depend on dynamically loaded libraries from the system, however, Slic3r can be told
to specifically look for static libraries with the `SLIC3R_STATIC` flag passed to cmake:
cmake .. -DSLIC3R_STATIC=1
-Additionally, SuperSlicer can be built in a static manner mostly independent of the system libraries with a dependencies bundle
+Additionally, Slic3r can be built in a static manner mostly independent of the system libraries with a dependencies bundle
created using CMake script in the `deps` directory (these are not interconnected with the rest of the CMake scripts).
Note: We say _mostly independent_ because it's still expected the system will provide some transitive dependencies, such as GTK for wxWidgets.
@@ -47,7 +61,7 @@ To do this, go to the `deps` directory, create a `build` subdirectory (or the li
where the target destdir is a directory of your choosing where the dependencies will be installed.
You can also omit the `DESTDIR` option to use the default, in that case the `destdir` will be created inside the `build` directory where `cmake` is run.
-To pass the destdir path to the top-level SuperSlicer CMake script, use the `CMAKE_PREFIX_PATH` option along with turning on `SLIC3R_STATIC`:
+To pass the destdir path to the top-level Slic3r CMake script, use the `CMAKE_PREFIX_PATH` option along with turning on `SLIC3R_STATIC`:
cmake .. -DSLIC3R_STATIC=1 -DCMAKE_PREFIX_PATH=<path to destdir>/usr/local
@@ -58,18 +72,18 @@ This is because wxWidgets hardcode the installation path.
### wxWidgets version
-SuperSlicer need at least wxWidgets 3.1
+Slic3r need at least wxWidgets 3.1
### Build variant
-By default SuperSlicer builds the release variant.
+By default Slic3r builds the release variant.
To create a debug build, use the following CMake flag:
-DCMAKE_BUILD_TYPE=Debug
### Enabling address sanitizer
-If you're using GCC/Clang compiler, it is possible to build SuperSlicer with the built-in address sanitizer enabled to help detect memory-corruption issues.
+If you're using GCC/Clang compiler, it is possible to build Slic3r with the built-in address sanitizer enabled to help detect memory-corruption issues.
To enable it, simply use the following CMake flag:
-DSLIC3R_ASAN=1
@@ -78,15 +92,15 @@ This requires GCC>4.8 or Clang>3.1.
### Installation
-At runtime, SuperSlicer needs a way to access its resource files. By default, it looks for a `resources` directory relative to its binary.
+At runtime, Slic3r needs a way to access its resource files. By default, it looks for a `resources` directory relative to its binary.
-If you instead want SuperSlicer installed in a structure according to the File System Hierarchy Standard, use the `SLIC3R_FHS` flag
+If you instead want Slic3r installed in a structure according to the File System Hierarchy Standard, use the `SLIC3R_FHS` flag
cmake .. -DSLIC3R_FHS=1
-This will make SuperSlicer look for a fixed-location `share/slic3r-prusa3d` directory instead (note that the location becomes hardcoded).
+This will make Slic3r look for a fixed-location `share/slic3r-prusa3d` directory instead (note that the location becomes hardcoded).
-You can then use the `make install` target to install SuperSlicer.
+You can then use the `make install` target to install Slic3r.
## Raspberry pi
diff --git a/doc/How to build - Mac OS.md b/doc/How to build - Mac OS.md
index b896159ee..312083e27 100644
--- a/doc/How to build - Mac OS.md
+++ b/doc/How to build - Mac OS.md
@@ -1,7 +1,7 @@
-# Building SuperSlicer on Mac OS
+# Building Slic3r on Mac OS
-To build SuperSlicer on Mac OS, you will need the following software:
+To build Slic3r on Mac OS, you will need the following software:
- XCode
- CMake
@@ -11,9 +11,22 @@ To build SuperSlicer on Mac OS, you will need the following software:
XCode is available through Apple's App Store, the other three tools are available on
[brew](https://brew.sh/) (use `brew install cmake git gettext` to install them).
+### How to get the source code
+
+You have to gitclone the repository
+```
+git clone https://github.com/slic3r/Slic3r.git
+```
+
+and then you have to clone the profiles submodules
+
+```
+cd resources/profiles
+git submodule update
+```
### How to build
-You can follow the [script](https://github.com/supermerill/SuperSlicer/blob/master/.github/workflows/ccpp_mac.yml) the build server use to create the ubuntu release.
+You can follow the [script](https://github.com/supermerill/Slic3r/blob/master/.github/workflows/ccpp_mac.yml) the build server use to create the ubuntu release.
You have to execute each command at the right of the 'run: ' tags, in the directory that is at the right of the previous 'working-directory:' tag.
@@ -24,8 +37,8 @@ You can stop after the `make slic3r` as the rest of the commands are for buildin
### Dependencies
-SuperSlicer comes with a set of CMake scripts to build its dependencies, it lives in the `deps` directory.
-Open a terminal window and navigate to SuperSlicer sources directory and then to `deps`.
+Slic3r comes with a set of CMake scripts to build its dependencies, it lives in the `deps` directory.
+Open a terminal window and navigate to Slic3r sources directory and then to `deps`.
Use the following commands to build the dependencies:
mkdir build
@@ -43,10 +56,10 @@ FIXME The Cereal serialization library needs a tiny patch on some old OSX clang
https://github.com/USCiLab/cereal/issues/339#issuecomment-246166717
-### Building SuperSlicer
+### Building Slic3r
-If dependencies are built without errors, you can proceed to build SuperSlicer itself.
-Go back to top level SuperSlicer sources directory and use these commands:
+If dependencies are built without errors, you can proceed to build Slic3r itself.
+Go back to top level Slic3r sources directory and use these commands:
mkdir build
cd build
@@ -55,7 +68,7 @@ Go back to top level SuperSlicer sources directory and use these commands:
The `CMAKE_PREFIX_PATH` is the path to the dependencies bundle but with `/usr/local` appended - if you set a custom path
using the `DESTDIR` option, you will need to change this accordingly. **Warning:** the `CMAKE_PREFIX_PATH` needs to be an absolute path.
-The CMake command above prepares SuperSlicer for building from the command line.
+The CMake command above prepares Slic3r for building from the command line.
To start the build, use
make -jN
@@ -66,12 +79,12 @@ Alternatively, if you would like to use XCode GUI, modify the `cmake` command to
cmake .. -GXcode -DCMAKE_PREFIX_PATH="$PWD/../deps/build/destdir/usr/local"
-and then open the `SuperSlicer.xcodeproj` file.
+and then open the `Slic3r.xcodeproj` file.
This should open up XCode where you can perform build using the GUI or perform other tasks.
### Note on Mac OS X SDKs
-By default SuperSlicer builds against whichever SDK is the default on the current system.
+By default Slic3r builds against whichever SDK is the default on the current system.
This can be customized. The `CMAKE_OSX_SYSROOT` option sets the path to the SDK directory location
and the `CMAKE_OSX_DEPLOYMENT_TARGET` option sets the target OS X system version (eg. `10.14` or similar).
@@ -80,9 +93,9 @@ In case you set both, the two settings need to agree with each other. (Building
is currently unsupported because some of the dependencies don't support this, most notably wxWidgets.)
Please note that the `CMAKE_OSX_DEPLOYMENT_TARGET` and `CMAKE_OSX_SYSROOT` options need to be set the same
-on both the dependencies bundle as well as SuperSlicer itself.
+on both the dependencies bundle as well as Slic3r itself.
-Official Mac SuperSlicer builds are currently built against SDK 10.9 to ensure compatibility with older Macs.
+Official Mac Slic3r builds are currently built against SDK 10.9 to ensure compatibility with older Macs.
_Warning:_ XCode may be set such that it rejects SDKs bellow some version (silently, more or less).
This is set in the property list file
diff --git a/doc/How to build - Windows.md b/doc/How to build - Windows.md
index cc4a77d54..cc750108a 100644
--- a/doc/How to build - Windows.md
+++ b/doc/How to build - Windows.md
@@ -1,11 +1,25 @@
-# Building SuperSlicer on Microsoft Windows
+# Building Slic3r on Microsoft Windows
-The currently supported way of building SuperSlicer on Windows is with CMake and [MS Visual Studio 2019](https://visualstudio.microsoft.com/fr/vs).
+The currently supported way of building Slic3r on Windows is with CMake and [MS Visual Studio 2019](https://visualstudio.microsoft.com/fr/vs).
CMake installer can be downloaded from [the official website](https://cmake.org/download/).~~
Building with [Visual Studio 2017 Community Edition](https://www.visualstudio.com/vs/older-downloads/). should work too.
+### How to get the source code
+
+You have to gitclone the repository
+```
+git clone https://github.com/slic3r/Slic3r.git
+```
+
+and then you have to clone the profiles submodules
+
+```
+cd resources/profiles
+git submodule update
+```
+
### How to build
You have to build the dependancies (in ./deps/build)
@@ -14,24 +28,24 @@ cmake .. -G "Visual Studio 16 2019" -A x64
msbuild /m ALL_BUILD.vcxproj
```
-and then build superslicer (in ./build):
+and then build Slic3r (in ./build):
```
-cmake .. -G "Visual Studio 16 2019" -A x64 -DCMAKE_PREFIX_PATH="PATH_TO_SuperSlicer\deps\build\destdir\usr\local"
+cmake .. -G "Visual Studio 16 2019" -A x64 -DCMAKE_PREFIX_PATH="PATH_TO_Slic3r\deps\build\destdir\usr\local"
msbuild /m /P:Configuration=Release INSTALL.vcxproj
```
You can also build it in visual studio, for that open the .sln.
-Note that you need to have `libgmp-10.dll` and `libmpfr-4.dll` next to your built superslicer. You can get them from any superslicer release.
+Note that you need to have `libgmp-10.dll` and `libmpfr-4.dll` next to your built Slic3r. You can get them from any Slic3r release.
-If you want to create the zipped release, you can follow this [script](https://github.com/supermerill/SuperSlicer/blob/master/.github/workflows/ccpp_win.yml).
+If you want to create the zipped release, you can follow this [script](https://github.com/supermerill/Slic3r/blob/master/.github/workflows/ccpp_win.yml).
# Old doc, not up-to-date:
### Building the dependencies package yourself
-The dependencies package is built using CMake scripts inside the `deps` subdirectory of SuperSlicer sources.
+The dependencies package is built using CMake scripts inside the `deps` subdirectory of Slic3r sources.
(This is intentionally not interconnected with the CMake scripts in the rest of the sources.)
-Open the preferred Visual Studio command line (64 or 32 bit variant, or just a cmd window) and `cd` into the directory with SuperSlicer sources.
+Open the preferred Visual Studio command line (64 or 32 bit variant, or just a cmd window) and `cd` into the directory with Slic3r sources.
Then `cd` into the `deps` directory and use these commands to build:
mkdir build
@@ -63,13 +77,13 @@ Refer to the CMake scripts inside the `deps` directory to see which dependencies
* Specifically, the problem arises when building boost. Boost build tool appends all build options into paths of intermediate files, which are not handled correctly by either `b2.exe` or possibly `ninja` (?).
-### Building SuperSlicer with Visual Studio
+### Building Slic3r with Visual Studio
-First obtain the SuperSlicer sources via either git or by extracting the source archive.
+First obtain the Slic3r sources via either git or by extracting the source archive.
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.
-When ready, open the relevant Visual Studio command line and `cd` into the directory with SuperSlicer sources.
+When ready, open the relevant Visual Studio command line and `cd` into the directory with Slic3r sources.
Use these commands to prepare Visual Studio solution file:
mkdir build
@@ -78,14 +92,14 @@ Use these commands to prepare Visual Studio solution file:
Note that the '-G "Visual Studio 15 Win64"' have to be the same as the one you sue for building the dependencies. So replace it the same way your replace it when you built the dependencies (if you did).
-If `cmake` has finished without errors, go to the build directory and open the `SuperSlicer.sln` solution file in Visual Studio.
-Before building, make sure you're building the right project (use one of those starting with `SuperSlicer_app_...`) and that you're building with the right configuration, i.e. _Release_ vs. _Debug_. When unsure, choose _Release_.
+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, i.e. _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.
#### Installing using the `INSTALL` project
-SuperSlicer can be run from the Visual Studio or from Visual Studio's build directory (`src\Release` or `src\Debug`), but for longer-term usage you might want to install somewhere using the `INSTALL` project.
-By default, this installs into `C:\Program Files\SuperSlicer`.
+Slic3r can be run from the Visual Studio or from Visual Studio's build directory (`src\Release` or `src\Debug`), but for longer-term usage you might want to install somewhere using the `INSTALL` project.
+By default, this installs into `C:\Program Files\Slic3r`.
To customize the install path, use the `-DCMAKE_INSTALL_PREFIX=<path of your choice>` when invoking `cmake`.
### Building from the command line