3DPrinting/PrusaSlicer-NonPlainar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial fixes on README to bring it up to date with Prusa changes

Browse Source 
The section about the command line arguments still needs addressing -
it is likely outdated and in need of updates.
This commit is contained in:
lf- 2019-04-06 19:29:25 -06:00
parent 2487bb8794
commit 68ec858e9a
1 changed files with 18 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -8,19 +8,20 @@ Prebuilt Windows, OSX and Linux binaries are available through the [git releases
<img width=256 src=https://cloud.githubusercontent.com/assets/31754/22719818/09998c92-ed6d-11e6-9fa0-09de638f3a36.png /> <img width=256 src=https://cloud.githubusercontent.com/assets/31754/22719818/09998c92-ed6d-11e6-9fa0-09de638f3a36.png />
Slic3r takes 3D models (STL, OBJ, AMF) and converts them into G-code instructions for Slic3r takes 3D models (STL, OBJ, AMF) and converts them into G-code
3D printers. It's compatible with any modern printer based on the RepRap toolchain, instructions for FFF printers or PNG layers for mSLA 3D printers. It's
including all those based on the Marlin, Sprinter and Repetier firmware. It also works compatible with any modern printer based on the RepRap toolchain, including all
those based on the Marlin, Prusa, Sprinter and Repetier firmware. It also works
with Mach3, LinuxCNC and Machinekit controllers. with Mach3, LinuxCNC and Machinekit controllers.
See the [project homepage](http://slic3r.org/) at slic3r.org and the See the [project homepage](https://www.prusa3d.com/slic3r-prusa-edition/) and
[manual](http://manual.slic3r.org/) for more information. the [documentation directory](doc/) for more information.
### What language is it written in? ### What language is it written in?
The core geometric algorithms and data structures are written in C++, All user facing code is written in C++, and some legacy code as well as unit
and Perl is used for high-level flow abstraction, GUI and testing. tests are written in Perl. Perl is not required for either development or use
If you're wondering why Perl, see https://xkcd.com/224/ of Slic3r.
The C++ API is public and its use in other projects is encouraged. The C++ API is public and its use in other projects is encouraged.
The goal is to make Slic3r fully modular so that any part of its logic The goal is to make Slic3r fully modular so that any part of its logic
@ -49,34 +50,23 @@ Other major features are:
* several infill patterns including honeycomb, spirals, Hilbert curves * several infill patterns including honeycomb, spirals, Hilbert curves
* 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** and output filename with variable placeholders * [customizable **G-code macros**](https://github.com/prusa3d/Slic3r/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
### How to install? ### Development
You can download a precompiled package from [slic3r.org](http://slic3r.org/); If you want to compile the source yourself, follow the instructions on one of
it will run without the need for any dependency. these documentation pages:
* [Linux](doc/How%20to%20build%20-%20Linux%20et%20al.md)
If you want to compile the source yourself follow the instructions on one of these wiki pages: * [macOS](doc/How%20to%20build%20-%20Mac%20OS.md)
* [Linux](https://github.com/alexrj/Slic3r/wiki/Running-Slic3r-from-git-on-GNU-Linux) * [Windows](doc/How%20to%20build%20-%20Windows.md)
* [Windows](https://github.com/prusa3d/Slic3r/wiki/How-to-compile-Slic3r-Prusa-Edition-on-MS-Windows)
* [Mac OSX](https://github.com/alexrj/Slic3r/wiki/Running-Slic3r-from-git-on-OS-X)
### 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:
* [Pull Request Milestone](https://github.com/alexrj/Slic3r/milestone/31) * Add an [issue](https://github.com/prusa3d/Slic3r/issues) to the github tracker if it isn't already present.
* Please comment in the related github issue that you are working on it so that other people know. * Look at [issues labeled "volunteer needed"](https://github.com/prusa3d/Slic3r/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3A%22volunteer+needed%22)
* Items in the [TODO](https://github.com/alexrj/Slic3r/wiki/TODO) wiki page.
* Please comment in the related github issue that you are working on it so that other people know.
* Drop me a line at aar@cpan.org.
* You can also find me (rarely) in #reprap and in #slic3r on [FreeNode](https://webchat.freenode.net) with the nickname _Sound_. Another contributor, _LoH_, is also in both channels.
* Add an [issue](https://github.com/alexrj/Slic3r/issues) 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.
### What's Slic3r license? ### What's Slic3r license?