From 0a0b20cf9864497180e1bd2df500c4f19629a3ca Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 23:50:19 -0400 Subject: [PATCH] Added directory structure. --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/README.md b/README.md index 4727c79..3582234 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ I am creating these files for my personal use and cannot be held responsible for - [Flash Firmware](#flash-firmware) - [Download Klipper Configuration](#download-klipper-configuration) - [Initial Steps](#initial-steps) +- [Directory Structure](#directory-structure) - [Support Me](#support-me) - [Useful Resources](#useful-resources) - [Sovol Official Links](#sovol-official-links) @@ -88,6 +89,56 @@ You can choose _either_ of the 2 following methods. Once you've cloned or downloaded the configuration, please follow instructions found in [Initial Steps](https://github.com/bassamanator/Sovol-SV06-firmware#initial-steps). +## Directory Structure + +This repository contains many files and folders. Some are _necessary_ for this Klipper configuration to work, others are not. + +- **Necessary** items are marked with a ✅. +- Items that can _optionally_ be deleted are marked with a ❌. + +``` +├── cfgs ✅ +│ ├── adxl-direct.cfg +│ ├── adxl-rp2040.cfg +│ ├── adxl-rpi-pico-2x.cfg +│ ├── MECHANICAL_GANTRY_CALIBRATION.cfg +│ ├── misc-macros.cfg +│ ├── PARKING.cfg +│ └── TEST_SPEED.cfg +├── CODE_OF_CONDUCT.md ❌ +├── CONTRIBUTING.md ❌ +├── .github ❌ +│ ├── FUNDING.yml +│ └── 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 ❌ +│ ├── M503-output.yml +│ ├── skr-mini +│ │ ├── klipper-USART2.bin +│ │ ├── klipper-USB.bin +│ │ ├── klipper-v0.11.0-198-g33b18fd6-latest-UNTESTED.bin +│ │ ├── ls-output.png +│ │ ├── menuconfig.png +│ │ ├── README.md +│ │ └── skr-mini-e3-v3.0-v1678580296384.png +│ ├── sv06-buildPlate.png +│ ├── SV06-buildPlate.stl +│ └── SV06-texture.svg +├── moonraker.conf ✅ +├── printer.cfg ✅ +├── README.md ❌ +└── .vscode ❌ + └── settings.json +``` + ## Support Me Please ⭐ star ⭐ this repository!