PublicArchives/Sovol-SV06-firmware
1
0
Fork 0
mirror of https://github.com/bassamanator/Sovol-SV06-firmware.git synced 2025-11-08 21:41:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adjust readme: add back to top to all sections.

Browse Source
This commit is contained in:
Bassam Husain
2023-11-26 04:19:43 -05:00
parent 18552711c5
commit 4600107faf
1 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -50,6 +50,8 @@ I am creating these files for my personal use and cannot be held responsible for
- `TEST_SPEED` macro. Find instructions [here](#how-do-i-use-the-test_speed-macro). - `TEST_SPEED` macro. Find instructions [here](#how-do-i-use-the-test_speed-macro).
- Klipper Adaptive Meshing & Purging (KAMP) integrated. Read about it [here](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging). - Klipper Adaptive Meshing & Purging (KAMP) integrated. Read about it [here](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging).
[⏮️ Back to top](#outline)
## Stay Up-to-Date ## Stay Up-to-Date
⭐ ${\normalsize{\textcolor{goldenrod}{\texttt{Star this project}}}}$ ⭐ ${\normalsize{\textcolor{goldenrod}{\texttt{Star this project}}}}$
@@ -58,10 +60,14 @@ Watch for releases and updates.
<img src="./images/githubstar.gif" width="500" alt='github star'/> <img src="./images/githubstar.gif" width="500" alt='github star'/>
[⏮️ Back to top](#outline)
## Preface ## Preface
Although I've made switching over to Klipper as easy as is possible, it can still be a challenge for some, especially considering that most of you have likely never used GNU+Linux. Save yourself the frustration, and _fully read all the documentation on this page_. Also note that Klipper is not a _must_, and is not for everyone. You can stick with Marlin, and have a fine 3D printing experience. Although I've made switching over to Klipper as easy as is possible, it can still be a challenge for some, especially considering that most of you have likely never used GNU+Linux. Save yourself the frustration, and _fully read all the documentation on this page_. Also note that Klipper is not a _must_, and is not for everyone. You can stick with Marlin, and have a fine 3D printing experience.
[⏮️ Back to top](#outline)
## Before You Begin ## Before You Begin
- This entire page is a **13 minute read**. Save yourself _hours of troubleshooting_ and read this documentation fully. - This entire page is a **13 minute read**. Save yourself _hours of troubleshooting_ and read this documentation fully.
@@ -77,6 +83,8 @@ Although I've made switching over to Klipper as easy as is possible, it can stil
- Your question has probably been answered already, but if it hasn't, please post in the [Discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions) section. - Your question has probably been answered already, but if it hasn't, please post in the [Discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions) section.
- 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. - 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.
[⏮️ Back to top](#outline)
## Klipper Installation ## Klipper Installation
### Flash Firmware ### Flash Firmware
@@ -109,6 +117,8 @@ Please note:
⏲️ At this point, it's not possible to tell with certainty whether your flash was successful, continue on with the guide. ⏲️ At this point, it's not possible to tell with certainty whether your flash was successful, continue on with the guide.
[⏮️ Back to top](#outline)
### Download OSS Klipper Configuration ### Download OSS Klipper Configuration
You can choose _either_ of the 2 following methods. You can choose _either_ of the 2 following methods.
@@ -128,6 +138,8 @@ You can choose _either_ of the 2 following methods.
3. The parent folder in the `ZIP` is `Sovol-SV06-firmware-master`. This is relevant in the next step. 3. The parent folder in the `ZIP` is `Sovol-SV06-firmware-master`. This is relevant in the next step.
4. Extract **only** the _contents_ of the parent folder into `~/printer_data/config`. 4. Extract **only** the _contents_ of the parent folder into `~/printer_data/config`.
[⏮️ Back to top](#outline)
## Initial Steps ## Initial Steps
### Adjust Configuration with MCU Path ### Adjust Configuration with MCU Path
@@ -153,6 +165,8 @@ You can choose _either_ of the 2 following methods.
If the Klipper flash that you did earlier was successful, and you've done everything else correctly, you should see no errors or warnings in the Mainsail/Fluidd dashboard. **Klipper has successfully been installed on your printer!** If the Klipper flash that you did earlier was successful, and you've done everything else correctly, you should see no errors or warnings in the Mainsail/Fluidd dashboard. **Klipper has successfully been installed on your printer!**
[⏮️ Back to top](#outline)
### Configure Your Printer ### Configure Your Printer
❗☠️ **Your finger should be on the power switch for most of these steps** ☠️❗ ❗☠️ **Your finger should be on the power switch for most of these steps** ☠️❗
@@ -194,6 +208,8 @@ You will be pasting/typing these commands into the Mainsail/Fluidd console.
But first, adjust your slicer. But first, adjust your slicer.
[⏮️ Back to top](#outline)
## Adjust Your Slicer ## Adjust Your Slicer
💡 If you are using the config bundles found on this repo, you can skip this step. 💡 If you are using the config bundles found on this repo, you can skip this step.
@@ -213,12 +229,16 @@ PRINT_START ...
PURGE_LINE PURGE_LINE
``` ```
[⏮️ Back to top](#outline)
## Support Me ## Support Me
Please ⭐ star this repository! Please ⭐ star this repository!
If you found my work useful, consider buying me a [<img src="./images/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator). If you found my work useful, consider buying me a [<img src="./images/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator).
[⏮️ Back to top](#outline)
## Directory Structure ## Directory Structure
This repository contains many files and folders. Some are _necessary_ for this Klipper configuration to work, others are not. This repository contains many files and folders. Some are _necessary_ for this Klipper configuration to work, others are not.
@@ -244,6 +264,8 @@ This repository contains many files and folders. Some are _necessary_ for this K
└── .vscode/ ❌ └── .vscode/ ❌
``` ```
[⏮️ Back to top](#outline)
## FAQ ## FAQ
### How do I import a configuration bundle into SuperSlicer/PrusaSlicer? ### How do I import a configuration bundle into SuperSlicer/PrusaSlicer?
@@ -354,6 +376,8 @@ Some tips:
Please see [this discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/111). Please see [this discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/111).
[⏮️ Back to top](#outline)
## Useful Resources ## Useful Resources
- [Everything Sovol SV06](https://github.com/bassamanator/everything-sovol-sv06) - [Everything Sovol SV06](https://github.com/bassamanator/everything-sovol-sv06)
@@ -361,12 +385,16 @@ Please see [this discussion](https://github.com/bassamanator/Sovol-SV06-firmware
- ⭐⭐⭐⭐⭐ [Ellis' Print Tuning Guide](https://ellis3dp.com/Print-Tuning-Guide) - ⭐⭐⭐⭐⭐ [Ellis' Print Tuning Guide](https://ellis3dp.com/Print-Tuning-Guide)
- [Simplify3D Print Quality Troubleshooting Guide](https://www.simplify3d.com/resources/print-quality-troubleshooting/) - [Simplify3D Print Quality Troubleshooting Guide](https://www.simplify3d.com/resources/print-quality-troubleshooting/)
[⏮️ Back to top](#outline)
## Sovol Official Links ## Sovol Official Links
- [SV06 Marlin Source Code](https://github.com/Sovol3d/Sv06-Source-Code) - [SV06 Marlin Source Code](https://github.com/Sovol3d/Sv06-Source-Code)
- [SV06 Models](https://github.com/Sovol3d/SV06-Fully-Open-Source) - [SV06 Models](https://github.com/Sovol3d/SV06-Fully-Open-Source)
- [SV06 Plus Marlin Source Code and Models](https://github.com/Sovol3d/SV06-PLUS) - [SV06 Plus Marlin Source Code and Models](https://github.com/Sovol3d/SV06-PLUS)
[⏮️ Back to top](#outline)
## Sources ## Sources
- [https://www.klipper3d.org](https://www.klipper3d.org) - [https://www.klipper3d.org](https://www.klipper3d.org)
@@ -379,3 +407,5 @@ Please see [this discussion](https://github.com/bassamanator/Sovol-SV06-firmware
- [PrusaSlicer Print Settings](https://github.com/mjonuschat/PrusaSlicer-Profiles) - [PrusaSlicer Print Settings](https://github.com/mjonuschat/PrusaSlicer-Profiles)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H0HIHTH) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H0HIHTH)
[⏮️ Back to top](#outline)