diff --git a/README.md b/README.md index db1cbae..26113bf 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ It operates in two steps: 2. Relocates the graphs and associated CSV files to your Klipper config folder for easy access via Mainsail/Fluidd to eliminate the need for SSH. 3. Manages the folder by retaining only the most recent results (default setting of keeping the latest three sets). -The [detailed documentation is here](./docs/README.md). +Check out the **[detailed documentation of the Shake&Tune module here](./docs/README.md)**. You can also look at the documentation for each type of graph by directly clicking on them below to better understand your results and tune your machine! -| Belts graphs | Axis graphs | Vibrations measurement | +| [Belts graph](./docs/macros/belts_tuning.md) | [Axis input shaper graphs](./docs/macros/axis_tuning.md) | [Vibrations graph](./docs/macros/vibrations_tuning.md) | |:----------------:|:------------:|:---------------------:| -| ![](./docs/images/belts_example.png) | ![](./docs/images/axis_example.png) | ![](./docs/images/vibrations_example.png) | +| [](./docs/macros/belts_tuning.md) | [](./docs/macros/axis_tuning.md) | [](./docs/macros/vibrations_tuning.md) | ## Installation diff --git a/docs/README.md b/docs/README.md index 329ca72..28e66dc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,13 +1,16 @@ # Klippain Shake&Tune module documentation +![](./banner_long.png) + ### Detailed documentation - 1. [Input Shaping and tuning generalities](./is_tuning_generalities.md) - 1. [Belt graphs](./macros/belts_tuning.md) - 1. [Axis Input Shaper graphs](./macros/axis_tuning.md) - 1. [Klippain vibrations graphs](./macros/vibrations_tuning.md) +First, check out **[input shaping and tuning generalities](./is_tuning_generalities.md)** to understand how it all works and what to look for when taking these measurements. +Then look at the documentation for each type of graph by clicking on them below to better understand your results and tune your machine! + +| [Belts graph](./macros/belts_tuning.md) | [Axis input shaper graphs](./macros/axis_tuning.md) | [Vibrations graph](./macros/vibrations_tuning.md) | +|:----------------:|:------------:|:---------------------:| +| [](./macros/belts_tuning.md) | [](./macros/axis_tuning.md) | [](./macros/vibrations_tuning.md) | -![](./banner.png) ### Complementary ressources diff --git a/docs/banner_long.png b/docs/banner_long.png new file mode 100644 index 0000000..b42c651 Binary files /dev/null and b/docs/banner_long.png differ