mirror of https://github.com/Desuuuu/klipper.git
docs: Update main README file to point to website
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
parent
b6637c6c73
commit
2d864489a0
33
README.md
33
README.md
|
@ -1,29 +1,16 @@
|
||||||
Welcome to the Klipper project!
|
Welcome to the Klipper project!
|
||||||
|
|
||||||
This project implements a 3d-printer firmware. There are two parts to
|
[![Klipper](docs/img/klipper-logo-small.png)](https://www.klipper3d.org/)
|
||||||
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](docs/Features.md) document to find out why you
|
https://www.klipper3d.org/
|
||||||
should use Klipper. To begin using Klipper start by
|
|
||||||
[installing](docs/Installation.md) it.
|
|
||||||
|
|
||||||
There is also [developer documentation](docs/Overview.md) available.
|
Klipper is a 3d-Printer firmware. It combines the power of a general
|
||||||
|
purpose computer with one or more micro-controllers. See the
|
||||||
|
[features document](https://www.klipper3d.org/Features.html) for more
|
||||||
|
information on why you should use Klipper.
|
||||||
|
|
||||||
License
|
To begin using Klipper start by
|
||||||
=======
|
[installing](https://www.klipper3d.org/Installation.html) it.
|
||||||
|
|
||||||
Klipper is free software: you can redistribute it and/or modify
|
Klipper is Free Software. See the [license](COPYING) or read the
|
||||||
it under the terms of the GNU General Public License as published by
|
[documentation](https://www.klipper3d.org/Overview.html).
|
||||||
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/>.
|
|
||||||
|
|
Loading…
Reference in New Issue