diff --git a/.vscode/settings.json b/.vscode/settings.json index 86b593b..06c7957 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,5 +2,7 @@ "editor.tabSize": 4, "editor.insertSpaces": true, "editor.detectIndentation": false, - "git.mergeEditor": false + "git.mergeEditor": false, + "spellright.language": ["en-US-10-1."], + "spellright.documentTypes": ["markdown", "latex", "plaintext"] } diff --git a/README.md b/README.md index 86ae262..99937e0 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ To do: - [ ] Replace M109/M190 with `TEMPERATURE_WAIT`. - [ ] Get the Ellis `TEST_SPEED` macro working. -- [ ] Add information about directory structure. +- [x] Add information about directory structure. - [ ] Create FAQ section. - [ ] 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` 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 ❌ +``` + ## Ko-fi Support Me Ko-fi If you found my work useful, please consider buying me a [Ko-fi](https://ko-fi.com/bassamanator).