29aa6ef6c7
Various installation updates. Recommend upgrade to OctoPrint v1.3.0. Recommend configuring OctoPrint to not disconnect on error. Note quirk with needing to reload page if "/tmp/printer" not in list of serial connections. Add brief documentation on use of extended commands and checking for errors. Signed-off-by: Kevin O'Connor <kevin@koconnor.net> |
||
---|---|---|
config | ||
docs | ||
klippy | ||
lib | ||
scripts | ||
src | ||
.gitignore | ||
COPYING | ||
Makefile | ||
README.md |
README.md
Welcome to the Klipper project!
This project implements a 3d-printer firmware. There are two parts to this firmware - code that runs on a micro-controller and code that runs on a host machine. The host software does the work to build a schedule of events, while the micro-controller software does the work to execute the provided schedule at the specified times.
See the features document to find out why you should use Klipper. To begin using Klipper start by installing it.
There is also developer documentation available.
License
Klipper is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Klipper is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Klipper. If not, see http://www.gnu.org/licenses/.