From d145c715cab039e0e3c09b9f06ad7d8fe95d7cb4 Mon Sep 17 00:00:00 2001 From: Daniel Duller <46626392+dadul96@users.noreply.github.com> Date: Sat, 15 Aug 2020 14:43:27 +0200 Subject: [PATCH] Update README.md --- README.md | 71 ++++++++++++++++++++++++++----------------------------- 1 file changed, 34 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 448c586b5..f402ccd13 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,11 @@ **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. -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. +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 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 -instructions for FFF printers or PNG layers for mSLA 3D printers. It's -compatible with any modern printer based on the RepRap toolchain, including all -those based on the Marlin, Prusa, Klipper and more firmware. +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. 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. @@ -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). * Brim rework: many more options (inside, outside only, 'ears', per object) * Some new seam options, to help hide them. -* built-in calibration prints -* built-in object generation script +* Built-in calibration prints +* Built-in object generation script * Can join perimeters into a big one to avoid travel moves. * Many other little options and corrections (like the filled concentric pattern). * It has also all the current slic3rPE/PrusaSlicer features. @@ -41,41 +39,40 @@ See the wiki for examples. Key features are: -* **multi-platform** (Linux/Mac/Win) and packaged as standalone-app with no dependencies required -* complete **command-line interface** to use it with no GUI -* multi-material **(multiple extruders)** object printing -* multiple G-code flavors supported (RepRap, Makerbot, Mach3, Machinekit etc.) -* ability to plate **multiple objects having distinct print settings** -* **multithread** processing +* **Multi-platform** (Linux/Mac/Win) and packaged as standalone-app with no dependencies required +* Complete **command-line interface** to use it without GUI +* Multi-material **(multiple extruders)** object printing +* Multiple G-code flavors supported (RepRap, Makerbot, Mach3, Machinekit, etc.) +* Ability to plate **multiple objects having distinct print settings** +* **Multithread** processing * **STL auto-repair** (tolerance for broken models) -* wide automated unit testing +* Wide automated unit testing 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) -* **multiple layer heights** in a single print -* **spiral vase** mode for bumpless vases -* fine-grained configuration of speed, acceleration, extrusion width -* several infill patterns including honeycomb, spirals, Hilbert curves, gyroid -* support material, raft, brim, skirt -* **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 -* support for **post-processing scripts** -* **cooling logic** controlling fan speed and dynamic print speed +* **Multiple layer heights** in a single print +* **Spiral vase** mode for bumpless vases +* Fine adjustment of speed, acceleration, and extrusion width +* Several infill patterns including honeycomb, spirals, Hilbert curves, gyroid +* Support material, raft, brim, skirt +* **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 +* Support for **post-processing scripts** +* **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 ### 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 command line interface is a thin wrapper over `libslic3r`. -You can download a precompiled package from the release page. -it will run without the need for any dependency. +The command-line interface is a thin wrapper over `libslic3r`. +You can download a precompiled package from the release page - it will run without the need for any dependency. ### How to compile @@ -85,26 +82,26 @@ these documentation pages: * [macOS](doc/How%20to%20build%20-%20Mac%20OS.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? 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 -changes: this way we'll ensure nobody wastes their time and no conflicts arise in development. +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 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_. -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 owned by Prusa Research. PrusaSlicer is originally based on Slic3r by Alessandro Ranellucci. 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.