Go to file
Kevin O'Connor d7a1111955 docs: Add backticks around commands in Firmware Commands
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-27 12:10:38 -04:00
config config: Add a sample config file for RAMBo boards 2017-04-26 11:51:40 -04:00
docs docs: Add backticks around commands in Firmware Commands 2017-04-27 12:10:38 -04:00
klippy gcode: Sort the order of commands in HELP 2017-04-26 10:44:22 -04:00
lib hub-ctrl: Add support for micro-controller reset via RPi usb power toggling 2017-04-13 13:20:13 -04:00
scripts scripts: Add octopi installation scripts 2017-04-21 10:14:27 -04:00
src build: Add workaround to suppress broken avr-gcc "misspelled" warnings 2017-04-24 08:54:10 -04: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: Add workaround to suppress broken avr-gcc "misspelled" warnings 2017-04-24 08:54:10 -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/.