Go to file
Kevin O'Connor 29aa6ef6c7 docs: Update installation document
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>
2016-12-21 12:01:39 -05:00
config config: Update avrsim.cfg with recent config file changes 2016-12-02 16:21:23 -05:00
docs docs: Update installation document 2016-12-21 12:01:39 -05:00
klippy gcode: Add a "STATUS" command 2016-12-21 11:35:00 -05:00
lib lib: Add Atmel SAM3x8e ARM CMSIS files 2016-06-14 14:25:42 -04:00
scripts graphstats: Updates for recent stats changes 2016-12-06 11:10:52 -05:00
src stepper: Reset the next step time on a stepper stop 2016-11-14 13:10:14 -05:00
.gitignore Initial commit of source code. 2016-05-25 11:37:40 -04:00
COPYING Initial commit of source code. 2016-05-25 11:37:40 -04:00
Makefile build: Be sure to also include out/*.d files in Makefile 2016-10-21 12:00:03 -04:00
README.md docs: Add a features document 2016-12-20 22:31:46 -05:00

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/.