Reword folder and file naming (#773)

* Reword folder and file naming

Specify the voron naming standard we all know from the manuals.

* Fix typo

* add opaque and transparent color

* fix clear/transparent in spirit of SB

* a-zA-Z
This commit is contained in:
newphreak 2022-07-26 23:41:05 +02:00 committed by GitHub
parent 5377889497
commit 3d093fee81
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions

View File

@ -11,8 +11,13 @@ to conform to the rules below are likely to be rejected.**
go to `firmware_configurations/`, slicer profiles go to `slicer_profiles/`. go to `firmware_configurations/`, slicer profiles go to `slicer_profiles/`.
Create a subfolder with your name, and place the mods in a subfolder with Create a subfolder with your name, and place the mods in a subfolder with
a descriptive name within that folder, e.g.: `/printer_mods/FHeilmann/flux_capacitor` a descriptive name within that folder, e.g.: `/printer_mods/FHeilmann/flux_capacitor`
* [ ] Folders names MUST NOT contain spaces. If possible, make sure file names also * [ ] Folder and file naming:
do not contain any spaces. * Folders and filenames shouldn't contain spaces. Only letters `a-zA-Z`, numbers `0-9`, underscores `_`, hyphens `-` and periods `.`
* Primary color: `part_xyz.stl`
* Accent color: `[a]_part_xyz.stl`
* Opaque color (Blocks light): `[o]_part_xyz.stl`
* Clear/transparent color (Allows light): `[c]_part_xyz.stl`
* Quantity, if more than one is needed: `part_xyz_x4.stl`
* [ ] For each mod, add a small `README.md` file to its folder with a short description * [ ] For each mod, add a small `README.md` file to its folder with a short description
of what the mod accomplishes. This readme can be used to add pictures, give assembly of what the mod accomplishes. This readme can be used to add pictures, give assembly
instructions or specify a bill of materials if the mod requires additional hardware. instructions or specify a bill of materials if the mod requires additional hardware.