diff --git a/README.md b/README.md index 5d40d54..bba4250 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,24 @@ This branch contains the OSS Klipper configuration that can be used with **any p 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. -# Features +## Outline + +- [Features](#features) +- [Stay Up-to-Date](#stay-up-to-date) +- [Installation Steps](#installation-steps) + - [Before You Begin](#before-you-begin) + - [Download the Configuration](#download-the-configuration) +- [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! πŸ’₯ CoreXY users can rightly disagree and say that it lacks the quad gantry levelling macros. Please create a pull request if you can help in this regard! -- `NEW` Filament runout sensor usage implemented. +- Filament runout sensor usage implemented. - Minimum configuration settings for Mainsail/Fluiddpi to work. - SuperSlicer config bundle that contains the printer configuration, as well as what are considered by many to be the best print settings available for any FDM printer ([Ellis' SuperSlicer Profiles](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles)). Find the differences between the different print setting profiles [here](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles/tree/master/SuperSlicer). But basically, the 45 degree profile places the seam at the back. - Macros @@ -24,15 +38,15 @@ I am creating these files for my personal use and cannot be held responsible for - Load/unload filament macros. - Purge line macro. -# Stay Up-to-Date +## Stay Up-to-Date -I work on this repository all the time and a lot of new features are coming. Watch releases of this repository to be notified for future updates: +Watch for releases and updates. Raspberry Pi -# Installation Steps +## Installation Steps -## Before You Begin +### Before You Begin - Know what you're getting into by reading this documentation _fully!_ - It is assumed that you are connected to your host Raspberry Pi (or other host device) via SSH, and that your printer motherboard is connected to the host via a data USB cable. @@ -40,20 +54,20 @@ I work on this repository all the time and a lot of new features are coming. Wat - It is assumed that you already have a working `printer.cfg` and you already have your printer up and running Klipper. - I would recommend searching for the word `NOTE` in this repository. There are roughly half a dozen short points amongst the various files that you should be aware of if you're using this configuration. -## Download the Configuration +### Download the Configuration 1. [Download](https://github.com/bassamanator/Sovol-SV06-firmware/archive/refs/heads/any-printer.zip) the `ZIP` file containing the Klipper configuration. 2. The parent folder in the `ZIP` is `Sovol-SV06-firmware-any-printer`. This is relevant in the next step. 3. Extract **only** the _contents_ of the parent folder into `~/printer_data/config`. -πŸ’‘ If you get a warning that you already have a `moonraker.conf` (which you probably do since you're already up and running Klipper), and _you're not using a low powered device such as the RPi Zero_, you need to simply paste the following into your _existing_ `moonraker.conf`: +πŸ’‘ **If** you get a warning that you already have a `moonraker.conf` (which you probably do since you're already up and running Klipper), **and** you're not using a low powered device such as a Raspberry Pi Zero, you need to simply paste the following into your _existing_ `moonraker.conf`: ``` [file_manager] enable_object_processing: True ``` -## Setup Instructions +### Setup Instructions Simply add `[include ./osskc.cfg]` somewhere at the top of your `printer.cfg`. @@ -68,30 +82,38 @@ This repository contains many files and folders. Some are _necessary_ for this K β”œβ”€β”€ cfgs βœ… β”‚ β”œβ”€β”€ adxl-direct.cfg β”‚ β”œβ”€β”€ adxl-rp2040.cfg +β”‚ β”œβ”€β”€ adxl-rpi-pico-2x.cfg β”‚ β”œβ”€β”€ MECHANICAL_GANTRY_CALIBRATION.cfg β”‚ β”œβ”€β”€ misc-macros.cfg β”‚ β”œβ”€β”€ PARKING.cfg β”‚ └── TEST_SPEED.cfg -β”œβ”€β”€ .vscode❌ -β”œβ”€β”€ .gitignore❌ +β”œβ”€β”€ CODE_OF_CONDUCT.md ❌ +β”œβ”€β”€ CONTRIBUTING.md ❌ +β”œβ”€β”€ .github ❌ +β”‚ └── ISSUE_TEMPLATE +β”‚ β”œβ”€β”€ bug_report.md +β”‚ └── feature_request.md +β”œβ”€β”€ .gitignore ❌ β”œβ”€β”€ images ❌ +β”‚ β”œβ”€β”€ cup-border.png β”‚ β”œβ”€β”€ githubstar.gif β”‚ β”œβ”€β”€ heart.gif +β”‚ β”œβ”€β”€ logo_white_stroke.png β”‚ └── party_blob.gif β”œβ”€β”€ misc ❌ -β”‚ β”œβ”€β”€ cup-border.png -β”‚ β”œβ”€β”€ logo_white_stroke.png β”‚ └── SuperSlicer_config_bundle.ini β”œβ”€β”€ moonraker.conf βœ… ❌ ΒΏ? (depends if you already have this file or not) β”œβ”€β”€ osskc.cfg βœ… -└── README.md ❌ +β”œβ”€β”€ README.md ❌ +└── .vscode ❌ + └── settings.json ``` -## Ko-fi Support Me Ko-fi +## Support Me -Please ⭐star⭐ this repository! +Please ⭐ star ⭐ this repository! - If you found my work useful, please consider buying me a [Ko-fi](https://ko-fi.com/bassamanator). +If you found my work useful, please consider buying me a [Ko-fi](https://ko-fi.com/bassamanator). ## FAQ @@ -104,12 +126,6 @@ Please find answers to common questions [here](https://github.com/bassamanator/S - ⭐⭐⭐⭐⭐ [Ellis' Print Tuning Guide](https://ellis3dp.com/Print-Tuning-Guide) - [Simplify3D Print Quality Troubleshooting Guide](https://www.simplify3d.com/resources/print-quality-troubleshooting/) -## Sovol Official Links - -- [SV06 Marlin Source Code](https://github.com/Sovol3d/Sv06-Source-Code) -- [SV06 Models](https://github.com/Sovol3d/SV06-Fully-Open-Source) -- [SV06 Plus Marlin Source Code and Models](https://github.com/Sovol3d/SV06-PLUS) - ## Sources - https://www.klipper3d.org