Skip to content

Latest commit

 

History

History
21 lines (11 loc) · 1.2 KB

README.md

File metadata and controls

21 lines (11 loc) · 1.2 KB

Gridfinity Rebuilt in KCL

License: MIT

Working repo to build a faithful KCL Implementation of Gridfinity from the ground up.

Gridfinity is originally developed by Zack Freedman

Guidelines for contributing

Merge PRs to the next branch, not main.

Gridfinity conforms to a set of style guidelines to ensure consistency and readability. https://github.com/KittyCAD/kcl-samples?tab=readme-ov-file#guidelines-for-adding-samples

  1. File Naming: Name your KCL files descriptively and concisely, using hyphens to separate words (e.g., flange.kcl, ball-bearing.kcl).

  2. File Header: Include a title comment at the top of each file, followed by a brief description explaining what the model is and its typical use cases.

  3. Inline Comments: Use inline comments to explain non-obvious parts of the code. Each major section should have a comment describing its purpose.

  4. Constants: Define constants at the beginning of your KCL files for any values that might change or need to be reused (e.g., dimensions, angles).