Go to file
sillyfrog ed011b5f25 dockerfile: Add a basic reference Dockerfile (#488)
Dockerfile: Add a basic reference Dockerfile

This is a sample of how to get Klipper running in Docker, because of the
virtual serial port, the user will have to modify things to include
something to send the GCode. I have included a link to my repo which has
OctoPrint up and running as an example.

Signed-off-by: Trent Davis <tgh@sillyfrog.com>
2018-08-06 13:11:01 -04:00
config config: Minor changes to example-extras.cfg documentation 2018-08-03 13:00:40 -04:00
docs docs: Minor change to wording of junction speeds 2018-08-03 15:48:07 -04:00
klippy klippy: Move tracking of accessed config items into _read_config() method 2018-08-03 18:54:23 -04:00
lib lpc176x: Add initial support for LPC176x processors 2018-05-25 11:52:13 -04:00
scripts dockerfile: Add a basic reference Dockerfile (#488) 2018-08-06 13:11:01 -04:00
src thermocouple: Minor fixes 2018-07-25 09:06:50 -04:00
test spi_temperature: Provide a default value for spi_speed 2018-07-24 15:49:14 -04:00
.gitignore Initial commit of source code. 2016-05-25 11:37:40 -04:00
.travis.yml build: Build pru gcc in travis-ci scripts and then cache it for later use 2018-06-28 17:01:11 -04:00
COPYING Initial commit of source code. 2016-05-25 11:37:40 -04:00
Makefile build: Add gcc option -std=gnu11 2018-05-21 09:43:48 -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/.