diff options
| -rw-r--r-- | docs/_layouts/default.html | 2 | ||||
| -rw-r--r-- | docs/index.md | 12 |
2 files changed, 13 insertions, 1 deletions
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 86c55029..104d1860 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -40,7 +40,7 @@ </button> <div class="collapse navbar-collapse" id="navbarNavAltMarkup"> <div class="navbar-nav ml-auto"> - <a class="nav-item nav-link" href="Overview.html">Index</a> + <a class="nav-item nav-link" href="Overview.html">Documentation</a> <a class="nav-item nav-link" href="https://github.com/KevinOConnor/klipper">Github</a> </div> </div> diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..da065701 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,12 @@ +Welcome to the Klipper project! + +Klipper is a 3d-Printer firmware. It combines the power of a general +purpose computer with one or more micro-controllers. See the +[features](Features.md) document for more information on why you +should use Klipper. + +To begin using Klipper start by [installing](Installation.md) it. + +Klipper is Free Software. Read the [documentation](Overview.md) or +view +[the Klipper code on github](https://github.com/KevinOConnor/klipper). |