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

github.com/prusa3d/PrusaSlicer.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorbubnikv <bubnikv@gmail.com>2019-05-13 13:42:40 +0300
committerbubnikv <bubnikv@gmail.com>2019-05-13 13:42:40 +0300
commit8da1c1953f42242d14ca397bfab2f4291ebed4f5 (patch)
tree90544ecd440a3b2f0ee1390607dbc39a0c4ff2e7 /doc
parent56256519cc122d440d851c8d3a41d11ba904b4b1 (diff)
Further renaming to PrusaSlicer
Diffstat (limited to 'doc')
-rw-r--r--doc/How to build - Linux et al.md30
-rw-r--r--doc/How to build - Mac OS.md22
-rw-r--r--doc/How to build - Windows.md20
3 files changed, 36 insertions, 36 deletions
diff --git a/doc/How to build - Linux et al.md b/doc/How to build - Linux et al.md
index 14ec23b2d..715b1388b 100644
--- a/doc/How to build - Linux et al.md
+++ b/doc/How to build - Linux et al.md
@@ -1,13 +1,13 @@
-# Building Slic3r PE on UNIX/Linux
+# Building PrusaSlicer on UNIX/Linux
-Slic3r PE uses the CMake build system and requires several dependencies.
+PrusaSlicer uses the CMake build system and requires several dependencies.
The dependencies can be listed in `deps/deps-linux.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.
-In a typical situation, one would open a command line, go to the Slic3r sources, create a directory called `build` or similar,
+In a typical situation, one would open a command line, go to the PrusaSlicer sources, create a directory called `build` or similar,
`cd` into it and call:
cmake ..
@@ -19,13 +19,13 @@ Additional CMake flags may be applicable as explained below.
### Dependency resolution
-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
+By default PrusaSlicer looks for dependencies the default way CMake looks for them, i.e. in default system locations.
+On Linux this will typically make PrusaSlicer depend on dynamically loaded libraries from the system, however, PrusaSlicer can be told
to specifically look for static libraries with the `SLIC3R_STATIC` flag passed to cmake:
cmake .. -DSLIC3R_STATIC=1
-Additionally, Slic3r can be built in a static manner mostly independent of the system libraries with a dependencies bundle
+Additionally, PrusaSlicer 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.
@@ -37,7 +37,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 Slic3r CMake script, use the `CMAKE_PREFIX_PATH` option along with turning on `SLIC3R_STATIC`:
+To pass the destdir path to the top-level PrusaSlicer 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
@@ -48,24 +48,24 @@ This is because wxWidgets hardcode the installation path.
### wxWidgets version
-By default, Slic3r PE looks for wxWidgets 3.1, this is because the 3.1 version has
+By default, PrusaSlicer looks for wxWidgets 3.1, this is because the 3.1 version has
a number of bugfixes and improvements not found in 3.0. However, it can also be built with wxWidgets 3.0.
This is done by passing this option to CMake:
-DSLIC3R_WX_STABLE=1
-Note that Slic3r PE is tested with wxWidgets 3.0 somewhat sporadically and so there may be bugs in bleeding edge releases.
+Note that PrusaSlicer is tested with wxWidgets 3.0 somewhat sporadically and so there may be bugs in bleeding edge releases.
### Build variant
-By default Slic3r builds the release variant.
+By default PrusaSlicer 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 Slic3r 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 PrusaSlicer 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
@@ -74,12 +74,12 @@ This requires GCC>4.8 or Clang>3.1.
### Installation
-At runtime, Slic3r needs a way to access its resource files. By default, it looks for a `resources` directory relative to its binary.
+At runtime, PrusaSlicer needs a way to access its resource files. By default, it looks for a `resources` directory relative to its binary.
-If you instead want Slic3r installed in a structure according to the File System Hierarchy Standard, use the `SLIC3R_FHS` flag
+If you instead want PrusaSlicer installed in a structure according to the File System Hierarchy Standard, use the `SLIC3R_FHS` flag
cmake .. -DSLIC3R_FHS=1
-This will make Slic3r look for a fixed-location `share/slic3r-prusa3d` directory instead (note that the location becomes hardcoded).
+This will make PrusaSlicer 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 Slic3r.
+You can then use the `make install` target to install PrusaSlicer.
diff --git a/doc/How to build - Mac OS.md b/doc/How to build - Mac OS.md
index 5af755564..590f48db1 100644
--- a/doc/How to build - Mac OS.md
+++ b/doc/How to build - Mac OS.md
@@ -1,12 +1,12 @@
-# Building Slic3r PE on Mac OS
+# Building PrusaSlicer on Mac OS
-To build Slic3r PE on Mac OS, you will need to install XCode, [CMake](https://cmake.org/) (available on Brew) and possibly git.
+To build PrusaSlicer on Mac OS, you will need to install XCode, [CMake](https://cmake.org/) (available on Brew) and possibly git.
### Dependencies
-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`.
+PrusaSlicer comes with a set of CMake scripts to build its dependencies, it lives in the `deps` directory.
+Open a terminal window and navigate to PrusaSlicer sources directory and then to `deps`.
Use the following commands to build the dependencies:
mkdir build
@@ -21,10 +21,10 @@ You can also customize the bundle output path using the `-DDESTDIR=<some path>`
(This is because wxWidgets hardcodes the installation path.)
-### Building Slic3r
+### Building PrusaSlicer
-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:
+If dependencies are built without errors, you can proceed to build PrusaSlicer itself.
+Go back to top level PrusaSlicer sources directory and use these commands:
mkdir build
cd build
@@ -33,7 +33,7 @@ Go back to top level Slic3r 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 Slic3r for building from the command line.
+The CMake command above prepares PrusaSlicer for building from the command line.
To start the build, use
make -jN
@@ -49,7 +49,7 @@ This should open up XCode where you can perform build using the GUI or perform o
### Note on Mac OS X SDKs
-By default Slic3r builds against whichever SDK is the default on the current system.
+By default PrusaSlicer 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).
@@ -58,9 +58,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 Slic3r PE itself.
+on both the dependencies bundle as well as PrusaSlicer itself.
-Official Mac Slic3r builds are currently built against SDK 10.9 to ensure compatibility with older Macs.
+Official Mac PrusaSlicer 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 331a3533a..71f74c66d 100644
--- a/doc/How to build - Windows.md
+++ b/doc/How to build - Windows.md
@@ -1,7 +1,7 @@
-# Building Slic3r PE on Microsoft Windows
+# Building PrusaSlicer 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 PrusaSlicer on Windows is with CMake and MS Visual Studio 2013.
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/).
@@ -11,7 +11,7 @@ _Note:_ Thanks to [**@supermerill**](https://github.com/supermerill) for testing
### Dependencies
-On Windows Slic3r is built against statically built libraries.
+On Windows PrusaSlicer is built against statically built libraries.
We provide a prebuilt package of all the needed dependencies. This package only works on Visual Studio 2013, so if you are using a newer version of Visual Studio, you need to compile the dependencies yourself as per [below](#building-the-dependencies-package-yourself).
The package comes in a several variants:
@@ -26,14 +26,14 @@ If you're unsure where to unpack the package, unpack it into `C:\local\` (but it
Alternatively you can also compile the dependencies yourself, see below.
-### Building Slic3r PE with Visual Studio
+### Building PrusaSlicer with Visual Studio
-First obtain the Slic3r PE sources via either git or by extracting the source archive.
+First obtain the PrusaSlicer 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.
For example on 64 bits this would be `C:\local\destdir-64\usr\local`. The prefix path will need to be passed to CMake.
-When ready, open the relevant Visual Studio command line and `cd` into the directory with Slic3r sources.
+When ready, open the relevant Visual Studio command line and `cd` into the directory with PrusaSlicer sources.
Use these commands to prepare Visual Studio solution file:
mkdir build
@@ -51,9 +51,9 @@ Note that you won't be able to build a _Debug_ variant against a _Release_-only
#### Installing using the `INSTALL` project
-Slic3r PE can be run from the Visual Studio or from Visual Studio's build directory (`src\Release` or `src\Debug`),
+PrusaSlicer 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`.
+By default, this installs into `C:\Program Files\PrusaSlicer`.
To customize the install path, use the `-DCMAKE_INSTALL_PREFIX=<path of your choice>` when invoking `cmake`.
### Building from the command line
@@ -75,10 +75,10 @@ To install, use `msbuild /P:Configuration=Release INSTALL.vcxproj` , `ninja inst
### Building the dependencies package yourself
-The dependencies package is built using CMake scripts inside the `deps` subdirectory of Slic3r PE sources.
+The dependencies package is built using CMake scripts inside the `deps` subdirectory of PrusaSlicer 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) and `cd` into the directory with Slic3r sources.
+Open the preferred Visual Studio command line (64 or 32 bit variant) and `cd` into the directory with PrusaSlicer sources.
Then `cd` into the `deps` directory and use these commands to build:
mkdir build