diff --git a/contributing.md b/contributing.md new file mode 100644 index 00000000..96ab12b2 --- /dev/null +++ b/contributing.md @@ -0,0 +1,31 @@ + +# Contributing + +This is a community driven project, and we welcome any contributions you'd like to make. You can connect with us on [discord](https://discord.gg/suyCCgr). + + +## Running Locally + +- Ensure you have [node](https://nodejs.org/en/download/), or an equivalent installed +- Clone the [repository](https://github.com/GridSpace/grid-apps) +- Run `npm run setup` +- Run `npm run dev` + +## Running Docs Locally + +- Ensure you have [node](https://nodejs.org/en/download/), or an equivalent installed +- Clone the [repository](https://github.com/GridSpace/grid-apps) +- Run `npm run setup` +- Run `npm run docs-dev` + + +## How to add a new machine + +- Make sure you have your tested machine selected +- Open the developer console +- Run the following code: `kiri.api.conf.get().device` +- Right click on the object and select `Copy object` +- Make a new file in the `src/kiri-dev/` directory, with the name of your machine, no spaces or special characters, and a `.json` extension. +- Paste the copied object into the new file, and save it. +- Publish your changes to a git repo +- Submit a [pull request](https://github.com/GridSpace/grid-apps/compare) \ No newline at end of file diff --git a/docs/kiri-moto/CAM/machines.md b/docs/kiri-moto/CAM/machines.md index 3f38d15e..a6af7d5e 100644 --- a/docs/kiri-moto/CAM/machines.md +++ b/docs/kiri-moto/CAM/machines.md @@ -37,7 +37,7 @@ Customize how your G-code is formatted for your controller or post-processor: - **Strip Comments** — Removes all G-code comments for cleaner, smaller files - **Token Spacer** — Inserts a space between G-code tokens (e.g., `G1 X1 Y1` vs `G1X1Y1`) -- **Enable Laser** — Activates laser-compatible G-code (typically uses `M3/M5`, adjusts movement strategy) +- **Enable Laser** — enables [Laser](ops#Laser-Mode-Only) operations (typically uses `M3/M5`, adjusts movement strategy) - **File Extension** — Optional override for exported file type (e.g., `.nc`, `.ngc`,`.cnc`,`.cam`, `.gcode`, `.txt`) > 💡 Leave the extension blank to default to `.gcode`. @@ -64,6 +64,9 @@ When a machine's file extention is set to `.rml`, Kiri Moto will use the RML dia ## Contribute a Machine Profile -We love to add new machines to the Kiri Moto library. If you have a machine that you'd like to add, you can export your workspace as a `.kmz` file, and share it on the [discord](https://discord.gg/suyCCgr) or [forums](htps://forum.grid.space) +We love to add new machines to the Kiri Moto library. If you have a tested machine that you'd like to add, you can export your workspace as a `.kmz` file, and share it on the [discord](https://discord.gg/suyCCgr) or [forums](htps://forum.grid.space). + +If you want to submit a PR, you can find instructions for how to do so [here](https://github.com/GridSpace/grid-apps/blob/master/contributing.md#how-to-add-a-new-machine). + + -Please [submit a pull request](https://github.com/kiri-moto/kiri-moto/pulls) to add it to the Kiri Moto library! diff --git a/docs/kiri-moto/CAM/ops.md b/docs/kiri-moto/CAM/ops.md index 4edb820e..58a6baef 100644 --- a/docs/kiri-moto/CAM/ops.md +++ b/docs/kiri-moto/CAM/ops.md @@ -5,6 +5,49 @@ label: ops # Operations -ops, not to be confused with [opps](https://knowyourmeme.com/memes/opp-opps) are the operations applied to a model to remove material. the operations supported by Kiri:Moto include: +ops, not to be confused with [opps](https://knowyourmeme.com/memes/opp-opps) are the operations applied to a model to remove material. The operations tab also contains meta operations that represent parts of the manufacturing process, but do not nessecarity generate toolpaths. + +These operation include: + +- Toolpath Operations + - Global + - [Outline](#outline) + - [level](#level) + - [rough](#rough) + - [contour](#contour) + - Specific + - [Drill](#drill) + - [Trace](#trace) + - [Pocket](#pocket) +- Other Operations + - [Gcode](#gcode) + - [Register](#register) +- Laser Operations + - [laser on](#laser-on) + - [laser off](#laser-off) +- Indexed Operations + - [Index](#index) + - [lathe](#lathe) + + +## Global Operations + +Operations that apply to all objects in the workspace. + +### Outline + +![](/img/CAM/outlineExample.png) + +The Outline op generates a toolpath surrounding the edges of a part. It is highly configurable and can select both internal or external edges specifically. The Outline operation is great for: + +- Cutting out many objects at once +- Generating a rough/finishing pass on an object +- Easily avoiding spefic parts like pockets or holes + +## Specific Operations + +### Outline + +## Laser Mode Only + -- [] diff --git a/docs/static/img/CAM/outlineExample.png b/docs/static/img/CAM/outlineExample.png new file mode 100644 index 00000000..cbe4990c Binary files /dev/null and b/docs/static/img/CAM/outlineExample.png differ