From 36d121551ecbab2b74f7181021f601ee58e74020 Mon Sep 17 00:00:00 2001 From: Jason Tibbitts Date: Fri, 7 Jun 2019 12:50:58 -0500 Subject: [PATCH] Provide useful README.md --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c73718..425bb46 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ -# prusa-slicer +# PrusaSlicer: 3D printing slicer optimized for Prusa printers -The prusa-slicer package \ No newline at end of file +PrusaSlicer 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, Sprinter and Repetier firmware. +It also works with +Mach3, LinuxCNC and Machinekit controllers. + +PrusaSlicer is based on Slic3r +by Alessandro Ranelucci +and the RepRap community. + +The maintainers of this package welcome community contributions. +The specfile, while moderately complicated +and with slightly unusual style, +should be well commented +and relatively easy to understand. +Please feel free to send PRs, +and provenpackagers should feel free +to commit and build as needed. +Please do send us a note if you need anything.