diff options
author | Damien <damlobster@gmail.com> | 2021-07-22 00:40:40 +0200 |
---|---|---|
committer | KevinOConnor <kevin@koconnor.net> | 2021-07-27 13:15:25 -0400 |
commit | cff61605fb7260ab60d1abd4e295b71a533869ac (patch) | |
tree | f117dd64e85ec18a62c7c4305781fa03d37ed0a9 /docs/Benchmarks.md | |
parent | 7e88f9220c641dd1e7e5b748381bd7ac758bc8d2 (diff) | |
download | kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.gz kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.xz kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.zip |
docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top.
Signed-off-by: Damien Martin <damlobster@gmail.com>
Update CNAME
Diffstat (limited to 'docs/Benchmarks.md')
-rw-r--r-- | docs/Benchmarks.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/Benchmarks.md b/docs/Benchmarks.md index 5514f7df..7ed16312 100644 --- a/docs/Benchmarks.md +++ b/docs/Benchmarks.md @@ -1,7 +1,9 @@ +# Benchmarks + This document describes Klipper benchmarks. Micro-controller Benchmarks -=========================== +--------------------------- This section describes the mechanism used to generate the Klipper micro-controller step rate benchmarks. @@ -23,7 +25,7 @@ or other innocuous pins. **Always verify that it is safe to drive the configured pins prior to running a benchmark.** It is not recommended to drive an actual stepper during a benchmark. -## Step rate benchmark test ## +### Step rate benchmark test ### The test is performed using the console.py tool (described in [Debugging.md](Debugging.md)). The micro-controller is configured for @@ -449,7 +451,7 @@ hub. | rp2040 (USB) | 873K | c5667193 | arm-none-eabi-gcc (Fedora 10.2.0-4.fc34) 10.2.0 | Host Benchmarks -=============== +--------------- It is possible to run timing tests on the host software using the "batch mode" processing mechanism (described in |