From ae3e0eefe180194c53ed7fa6ef5a3a7cd0d1d6d4 Mon Sep 17 00:00:00 2001
From: Rainboooom <131979403+Rainboooom@users.noreply.github.com>
Date: Thu, 15 Jun 2023 10:54:02 +0800
Subject: [PATCH] Create README.md

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fbe49ff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+<p align="center"><img src="https://github.com/QIDITECH/QIDI_MAX3/blob/main/other/QIDI.png" height="240" alt="QIDI's logo" /></p>
+<p align="center"><a href="LICENSE"><img alt="GPL-V3.0 License" src="https://github.com/QIDITECH/QIDI_MAX3/blob/main/other/qidi.svg"></a></p>
+
+# Document Instructions
+The 3D printers of QIDI are based on Klipper.Based on the Klipper open source project, we have made some modifications to its source code to meet some of the user's needs.At the same time, we have also made modifications to Moonraker, so that the screens we set can correspond to the operations on the page.
+Thanks to the developers and maintainers of these open source projects.Please consider using or supporting these powerful projects.
+- <a href="https://github.com/Klipper3d/klipper">**Klipper**</a>
+- <a href="https://github.com/Arksine/moonraker">**Moonraker**</a>
+
+1. This document provides the modified moonraker version of QIDI.
+2. This document only provides methods for replacing source code for updates.
+***Please note that manual updates may affect normal after-sales service.***  
+
+## Detailed update process
+1. Connect your printer device through SSH.
+2. Confirm which software you need to replace.Download the corresponding file and replace the software through SSH connection.The following are the paths of each software within the system.
+
+  Software|Directory
+  ---|---
+  klipper|/home/mks/
+  moonraker|/home/mks/
+
+3. If there is no need to update xindi, simply replace it. For example, if I replace the klipper folder, save it and restart it.
+
+## Report Issues and Make Suggestions
+You can contact [After-Sales Service](https://qidi3d.com/pages/warranty-policy-after-sales-support) to report issues and make suggestions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+