Go to file
Kevin O'Connor 57cf0759c0 docs: Add logos to web page
Also, move docs/index.md to docs/_layouts/home.html.  Add a
docs/_layouts/README file.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-18 22:35:35 -04:00
config display: Add ST7567 display support (#1540) 2019-04-15 21:07:29 -04:00
docs docs: Add logos to web page 2019-04-18 22:35:35 -04:00
klippy temperature_fan: Add gcode command for temperature_fan.py (#1520) 2019-04-15 21:13:29 -04:00
lib lib: Add stm32f0 hal and cmsis files 2019-03-24 12:10:11 -04:00
scripts klippy-requirements: Update Jinja2 version 2019-04-14 11:20:04 -04:00
src lpc176x: refactor usbserial to use udelay helper. 2019-04-06 20:53:15 -04:00
test config: Generic board BIGTREETECH SKR V.1.3 config 2019-04-05 19:56:22 -04:00
.gitignore util: Fix versioning when gitdir is absent (#809) 2018-10-27 10:44:38 -04:00
.travis.yml test: Update .travis.yml to list apt packages one per line 2018-08-17 09:47:57 -04:00
COPYING Initial commit of source code. 2016-05-25 11:37:40 -04:00
Makefile Makefile: Fix lpc176x and stm32f1 builds 2019-03-02 11:26:14 -05: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/.