Update README.md

This commit is contained in:
Daniel Duller 2020-08-15 14:43:27 +02:00 committed by supermerill
parent 25886cd920
commit d145c715ca

View File

@ -3,13 +3,11 @@
**A PrusaSlicer fork (which is a slic3r fork)** (previously Slic3r++) **A PrusaSlicer fork (which is a slic3r fork)** (previously Slic3r++)
Prebuilt Windows, Linux and macos 64b releases are available through the [git releases page](https://github.com/supermerill/SuperSlicer/releases). The linux & macos aren't tested (by me), just compiled, so report me any bugs that can occur on them. Prebuilt Windows, Linux and macOS 64-bit releases are available through the [git releases page](https://github.com/supermerill/SuperSlicer/releases). The Linux & macOS builds aren't tested (by me), just compiled, so please report any bugs that may occur during use.
Nightly builds are available through the [git actions page](https://github.com/supermerill/SuperSlicer/actions). Click on the a build for your plateform and then on 'Artifacts (1)' in the top right corner. Nightly builds are available through the [git actions page](https://github.com/supermerill/SuperSlicer/actions). Click on the build for your platform and then on 'Artifacts (1)' in the top right corner.
SuperSlicer takes 3D models (STL, OBJ, AMF) and converts them into G-code SuperSlicer takes 3D models (STL, OBJ, AMF) and converts them into G-code
instructions for FFF printers or PNG layers for mSLA 3D printers. It's instructions for FFF printers or PNG layers for mSLA 3D printers. It's compatible with any modern printer based on the RepRap toolchain which is running a firmware based on Marlin, Prusa, Klipper, etc.
compatible with any modern printer based on the RepRap toolchain, including all
those based on the Marlin, Prusa, Klipper and more firmware.
SuperSlicer is based on [PrusaSlicer](https://github.com/prusa3d/PrusaSlicer) by Prusa Research. SuperSlicer is based on [PrusaSlicer](https://github.com/prusa3d/PrusaSlicer) by Prusa Research.
PrusaSlicer is based on [Slic3r](https://github.com/Slic3r/Slic3r) by Alessandro Ranelucci and the RepRap community. PrusaSlicer is based on [Slic3r](https://github.com/Slic3r/Slic3r) by Alessandro Ranelucci and the RepRap community.
@ -27,8 +25,8 @@ the [documentation directory](doc/) for information about compilation.
* Better overhangs (add perimeters if needed, slice them in opposite direction each layer). * Better overhangs (add perimeters if needed, slice them in opposite direction each layer).
* Brim rework: many more options (inside, outside only, 'ears', per object) * Brim rework: many more options (inside, outside only, 'ears', per object)
* Some new seam options, to help hide them. * Some new seam options, to help hide them.
* built-in calibration prints * Built-in calibration prints
* built-in object generation script * Built-in object generation script
* Can join perimeters into a big one to avoid travel moves. * Can join perimeters into a big one to avoid travel moves.
* Many other little options and corrections (like the filled concentric pattern). * Many other little options and corrections (like the filled concentric pattern).
* It has also all the current slic3rPE/PrusaSlicer features. * It has also all the current slic3rPE/PrusaSlicer features.
@ -41,41 +39,40 @@ See the wiki for examples.
Key features are: Key features are:
* **multi-platform** (Linux/Mac/Win) and packaged as standalone-app with no dependencies required * **Multi-platform** (Linux/Mac/Win) and packaged as standalone-app with no dependencies required
* complete **command-line interface** to use it with no GUI * Complete **command-line interface** to use it without GUI
* multi-material **(multiple extruders)** object printing * Multi-material **(multiple extruders)** object printing
* multiple G-code flavors supported (RepRap, Makerbot, Mach3, Machinekit etc.) * Multiple G-code flavors supported (RepRap, Makerbot, Mach3, Machinekit, etc.)
* ability to plate **multiple objects having distinct print settings** * Ability to plate **multiple objects having distinct print settings**
* **multithread** processing * **Multithread** processing
* **STL auto-repair** (tolerance for broken models) * **STL auto-repair** (tolerance for broken models)
* wide automated unit testing * Wide automated unit testing
Other major features are: Other major features are:
* combine infill every 'n' perimeters layer & varying density to speed up printing * Combine infill every 'n' perimeters layer & varying density to speed up printing
* **3D preview** (including multi-material files) * **3D preview** (including multi-material files)
* **multiple layer heights** in a single print * **Multiple layer heights** in a single print
* **spiral vase** mode for bumpless vases * **Spiral vase** mode for bumpless vases
* fine-grained configuration of speed, acceleration, extrusion width * Fine adjustment of speed, acceleration, and extrusion width
* several infill patterns including honeycomb, spirals, Hilbert curves, gyroid * Several infill patterns including honeycomb, spirals, Hilbert curves, gyroid
* support material, raft, brim, skirt * Support material, raft, brim, skirt
* **standby temperature** and automatic wiping for multi-extruder printing * **Standby temperature** and automatic wiping for multi-extruder printing
* [customizable **G-code macros**](https://github.com/prusa3d/PrusaSlicer/wiki/Slic3r-Prusa-Edition-Macro-Language) and output filename with variable placeholders * [Customizable **G-code macros**](https://github.com/prusa3d/PrusaSlicer/wiki/Slic3r-Prusa-Edition-Macro-Language) and output filename with variable placeholders
* support for **post-processing scripts** * Support for **post-processing scripts**
* **cooling logic** controlling fan speed and dynamic print speed * **Cooling logic** controlling fan speed and dynamic print speed
[Command Line Interface](https://github.com/prusa3d/PrusaSlicer/wiki/Command-Line-Interface) wiki page. [Command-Line Interface](https://github.com/prusa3d/PrusaSlicer/wiki/Command-Line-Interface) wiki page.
## Development ## Development
### What language is it written in? ### What language is it written in?
Almost everything are written in C++, Almost everything is written in C++.
The slicing core is the `libslic3r` library, which can be built and used in a standalone way. The slicing core is the `libslic3r` library, which can be built and used in a standalone way.
The command line interface is a thin wrapper over `libslic3r`. The command-line interface is a thin wrapper over `libslic3r`.
You can download a precompiled package from the release page. You can download a precompiled package from the release page - it will run without the need for any dependency.
it will run without the need for any dependency.
### How to compile ### How to compile
@ -85,26 +82,26 @@ these documentation pages:
* [macOS](doc/How%20to%20build%20-%20Mac%20OS.md) * [macOS](doc/How%20to%20build%20-%20Mac%20OS.md)
* [Windows](doc/How%20to%20build%20-%20Windows.md) * [Windows](doc/How%20to%20build%20-%20Windows.md)
Also, you can look at the worklow yaml files for [git actions](https://github.com/supermerill/Slic3r/tree/master/.github/workflows), as they describe how to build from source from a "virgin" dev computer. You can also look at the workflow YAML-files for [git actions](https://github.com/supermerill/Slic3r/tree/master/.github/workflows), as they describe how to build from source from a "virgin" dev computer.
### Can I help? ### Can I help?
Sure! You can do the following to find things that are available to help with: Sure! You can do the following to find things that are available to help with:
* Add an issue to the github tracker **if it isn't already present**. * Add an issue to the GitHub tracker **if it isn't already present**.
Before sending patches and pull requests contact me (preferably through opening a github issue or commenting on an existing, related, issue) to discuss your proposed Before sending patches and pull requests contact me (preferably through opening a GitHub issue or commenting on an existing, related, issue) to discuss your proposed
changes: this way we'll ensure nobody wastes their time and no conflicts arise in development. changes. This way we can ensure that nobody wastes their time and no conflicts arise in development.
## Licence and attribution ## License and attribution
SuperSlicer is licensed under the _GNU Affero General Public License, version 3_. SuperSlicer is licensed under the _GNU Affero General Public License, version 3_.
The SuperSlicer is based on PrusaSlicer by PrusaResearch. SuperSlicer is based on PrusaSlicer by PrusaResearch.
PrusaSlicer is licensed under the _GNU Affero General Public License, version 3_. PrusaSlicer is licensed under the _GNU Affero General Public License, version 3_.
PrusaSlicer is owned by Prusa Research. PrusaSlicer is owned by Prusa Research.
PrusaSlicer is originally based on Slic3r by Alessandro Ranellucci. PrusaSlicer is originally based on Slic3r by Alessandro Ranellucci.
Slic3r is licensed under the _GNU Affero General Public License, version 3_. Slic3r is licensed under the _GNU Affero General Public License, version 3_.
The first author is Alessandro Ranellucci, and many contributors Slic3r was created by Alessandro Ranellucci with the help of many other contributors.
The _GNU Affero General Public License, version 3_ ensure that if you **use** any part of this software in any way (even behind a web server), your software must be released under the same licence. The _GNU Affero General Public License, version 3_ ensures that if you **use** any part of this software in any way (even behind a web server), your software must be released under the same license.