From 089ad6a4bd8279f13125cc1899c4ced1caac5fee Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 22:05:51 -0400 Subject: [PATCH] Added outline. --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 64187c7..a74f774 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,26 @@ This branch contains the Klipper configuration and firmware for the **Sovol SV06 I am creating these files for my personal use and cannot be held responsible for what it might do to your printer. Use at your own risk. +## Outline + +- [Features](#features) +- [Stay Up-to-Date](#stay-up-to-date) +- [Preface](#preface) +- [Installation Steps](#installation-steps) + - [Before You Begin](#before-you-begin) + - [Flash Firmware](#flash-firmware) + - [Download Klipper Configuration](#download-klipper-configuration) +- [Initial Steps](#initial-steps) + 1. [Adjust Configuration with MCU Path](#adjust-configuration-with-mcu-path) + 2. [Configure Your Printer](#configure-your-printer) +- [Adjust Your Slicer](#adjust-your-slicer) +- [Directory Structure](#directory-structure) +- [Support Me](#support-me) +- [FAQ](#faq) +- [Useful Resources](#useful-resources) +- [Sovol Official Links](#sovol-official-links) +- [Sources](#sources) + ## Features - 💥 This Klipper configuration is an _endpoint_, meaning that it contains **everything** that you could possibly need in order to have an excellent Klipper experience! 💥 @@ -89,7 +109,7 @@ You can choose _either_ of the 2 following methods. 1. `cd ~/printer_data/config` 2. Empty entire `~/printer_data/config` folder. - In linux, you can delete files via `rm fileName` and directories via `rmdir directoryName`. -3. `git clone -b master --single-branch https://github.com/bassamanator/Sovol-SV06-firmware.git .` ⚠️ Don't miss the period! +3. `git clone -b master --single-branch https://github.com/bassamanator/Sovol-SV06-firmware.git .` ⚠️ Don't miss the period! #### Method 2: Download the ZIP @@ -100,7 +120,7 @@ You can choose _either_ of the 2 following methods. ## Initial Steps -### Step 1 +### Adjust Configuration with MCU Path 1. Find what port the `mcu` (printer motherboard) is connected to via `ls -l /dev/serial/by-id/` or `ls -l /dev/serial/by-path/`. 1. The output will be something along the lines of @@ -120,7 +140,7 @@ You can choose _either_ of the 2 following methods. If you've done everything correctly, you should see no errors or warnings in your Mainsail/Fluidd dashboard. -### Step 2 +### Configure Your Printer ❗☠️ **Your finger should be on the power switch for most of these steps** ☠️❗