aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2016-12-20 22:22:54 -0500
committerKevin O'Connor <kevin@koconnor.net>2016-12-20 22:31:46 -0500
commit18456f71f873ea3d48ac0d81b1382b0c749288d9 (patch)
treea6226194cd351e5e529aed8cee863a27e47eb839 /README.md
parent1d841eeb876082d9efbf2fa7f04bccc259f40ef9 (diff)
downloadkutter-18456f71f873ea3d48ac0d81b1382b0c749288d9.tar.gz
kutter-18456f71f873ea3d48ac0d81b1382b0c749288d9.tar.xz
kutter-18456f71f873ea3d48ac0d81b1382b0c749288d9.zip
docs: Add a features document
Add a document describing some high-level features in Klipper. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index f594c95d..1dcfbefd 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,11 @@ 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.
+See the [features](docs/Features.md) document to find out why you
+should use Klipper. To begin using Klipper start by
+[installing](docs/Installation.md) it.
+
+There is also [developer documentation](docs/Overview.md) available.
License
=======