diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..f594c95d3 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +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. + +Please see the [documentation](docs/Overview.md) for more information +on running and working with Klipper. + +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/>. |