Added directory structure information.

This commit is contained in:
bassamanator
2023-02-27 22:10:59 -05:00
parent 119c313434
commit c02a3bc5cb
2 changed files with 35 additions and 2 deletions

View File

@@ -2,5 +2,7 @@
"editor.tabSize": 4, "editor.tabSize": 4,
"editor.insertSpaces": true, "editor.insertSpaces": true,
"editor.detectIndentation": false, "editor.detectIndentation": false,
"git.mergeEditor": false "git.mergeEditor": false,
"spellright.language": ["en-US-10-1."],
"spellright.documentTypes": ["markdown", "latex", "plaintext"]
} }

View File

@@ -23,7 +23,7 @@ To do:
- [ ] Replace M109/M190 with `TEMPERATURE_WAIT`. - [ ] Replace M109/M190 with `TEMPERATURE_WAIT`.
- [ ] Get the Ellis `TEST_SPEED` macro working. - [ ] Get the Ellis `TEST_SPEED` macro working.
- [ ] Add information about directory structure. - [x] Add information about directory structure.
- [ ] Create FAQ section. - [ ] Create FAQ section.
- [ ] Finalize filament sensor config and merge into `master`. - [ ] Finalize filament sensor config and merge into `master`.
@@ -118,6 +118,37 @@ You can choose *either* of the 2 following methods.
5. `BED_MESH_CALIBRATE` 5. `BED_MESH_CALIBRATE`
6. `SAVE_CONFIG` (once completed) 6. `SAVE_CONFIG` (once completed)
## 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
│   ├── beeper.cfg
│   ├── macros.cfg
│   ├── MECHANICAL_GANTRY_CALIBRATION.cfg
│   ├── PARKING.cfg
│   └── TEST_SPEED.cfg [☠Not ready for use☠]
├── images ❌
│   └── githubstar.gif
├── misc ❌
│   ├── cup-border.png
│   ├── klipper.bin
│   ├── logo_white_stroke.png
│   ├── M503-output.yml
│   ├── SuperSlicer_config_bundle.ini
│   ├── sv06-buildPlate.png
│   ├── SV06-buildPlate.stl
│   └── SV06-texture.svg
├── moonraker.conf ✅
├── printer.cfg ✅
└── README.md ❌
```
## <img src="./misc/cup-border.png" width="30" alt='Ko-fi'/> Support Me <img src="./misc/cup-border.png" width="30" alt='Ko-fi'/> ## <img src="./misc/cup-border.png" width="30" alt='Ko-fi'/> Support Me <img src="./misc/cup-border.png" width="30" alt='Ko-fi'/>
If you found my work useful, please consider buying me a [<img src="./misc/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator). If you found my work useful, please consider buying me a [<img src="./misc/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator).