diff --git a/readme.md b/readme.md index 2b3b2c8f..6d581c16 100644 --- a/readme.md +++ b/readme.md @@ -1,18 +1,4 @@ -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/gridspace3d?locale.x=en_US) - -Contributions in all forms (code, bug reports, community engagement, localization, etc) are warmly welcomed. - -[![Discord](https://img.shields.io/discord/688863523207774209)](https://discord.com/channels/688863523207774209/688863523211968535) -![GitHub](https://img.shields.io/github/license/GridSpace/grid-apps) -![Twitter Follow](https://img.shields.io/twitter/follow/grid_space_3d?label=follow&style=social) - -### Hosted Apps - -* [Grid.Space](https://grid.space) hosts [several live versions](https://grid.space/choose) of the code -* [Kiri:Moto](https://grid.space/kiri) -- A Unique, Multi-Modal, Browser-based Slicer for 3D printers, CNC mills and Laser cutters -* [Mesh:Tool](https://grid.space/mesh) -- Coming Soon. A browser based mesh repair and editing tool - -### Live Versions +## Grid.Space Web Applications [![Website](https://img.shields.io/website?url=https%3A%2F%2Fgrid.space%2F)](https://grid.space/kiri/) ![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/GridSpace/grid-apps/rel-2.6) @@ -21,19 +7,37 @@ Contributions in all forms (code, bug reports, community engagement, localizatio ![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/GridSpace/grid-apps/rel-2.9) ![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/GridSpace/grid-apps/rel-3.0) -### Development Activity +[`Grid.Space`](https://grid.space) hosts [several live versions](https://grid.space/choose) of this code + +[`Kiri:Moto`](https://grid.space/kiri) is a browser-based Slicer for 3D printers, CNC mills, and Laser cutters + +[`Mesh:Tool`](https://grid.space/mesh) is a browser-based mesh repair and editing tool + +## Primary Documentation + +https://docs.grid.space/projects/kiri-moto + +https://docs.grid.space/projects/mesh-tool + +## Development Activity ![GitHub commit activity](https://img.shields.io/github/commit-activity/w/GridSpace/grid-apps) ![GitHub last commit](https://img.shields.io/github/last-commit/GridSpace/grid-apps) ![GitHub contributors](https://img.shields.io/github/contributors/GridSpace/grid-apps) -## Community +## Community Engagement -* [Discord](https://discord.com/invite/suyCCgr) -* [YouTube](https://www.youtube.com/c/gridspace) -* [Twitter](https://twitter.com/grid_space_3d) +[Discord](https://discord.com/invite/suyCCgr) + | [YouTube](https://www.youtube.com/c/gridspace) + | [Twitter](https://twitter.com/grid_space_3d) -### Testing Locally (with Docker) +[![Discord](https://img.shields.io/discord/688863523207774209)](https://discord.com/channels/688863523207774209/688863523211968535) +![GitHub](https://img.shields.io/github/license/GridSpace/grid-apps) +[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/gridspace3d?locale.x=en_US) +![Twitter Follow](https://img.shields.io/twitter/follow/grid_space_3d?label=follow&style=social) + + +## Testing Locally (with Docker) ``` git clone git@github.com:GridSpace/grid-apps.git @@ -41,7 +45,7 @@ cd grid-apps docker-compose -f src/dock/compose.yml up ``` -### Testing Locally (with NodeJS) +## Testing Locally (with NodeJS) ``` git clone git@github.com:GridSpace/grid-apps.git @@ -78,11 +82,11 @@ your path. You can either add it to your path, or you can run: You can now access your environment of grid-apps by going to [localhost:8080/kiri](http://127.0.0.1:8080/kiri) -### Windows Developers +## Windows Developers this git repo requires symbolic link support. on Windows, this means you have to clone the repo in a command shell with Administrator privileges. -### Other Start Options +## Other Start Options ``` gs-app-server @@ -92,13 +96,9 @@ web site. requires node.js 12+ -### Javascript Slicing APIs +## Javascript Slicing APIs A script include that injects a web worker into the page that will asynchronously perform any of Kiri’s slicing and gcode generation functions. And a frame messaging API for controlling Kiri:Moto inside an IFrame. * https://grid.space/kiri/engine.html * https://grid.space/kiri/frame.html - -### More Documentation - -* https://docs.grid.space/projects/kiri-moto diff --git a/release.md b/release.md new file mode 100644 index 00000000..c565c6b4 --- /dev/null +++ b/release.md @@ -0,0 +1,29 @@ +# Release Notes + +## `C` complete, `P` partial, `-` todo + +# Release 3.3 + +## Kiri:Moto + +* `C` reorganization of code to use updated dependency loader +* `C` refactor main into supporting classes (part of a larger ui re-org) +* `C` group "main" entry points under "kiri-run" +* `C` extract and group utilities from print and other modules +* `P` refactor slicers to use single improved slice core (cnc tbd) +* `C` add thin wall pull-down & allow for newer strategies +* `C` extract preview render engine from FDM +* `C` allow loading of workspaces from url on page load +* `C` properly import profiles attached to devices +* `C` improved routing on "fast" layers & layers with multiple islands +* `P` template vars: nozzles used and layers until next use (IDEX) +* `-` start/stop minions depending on whether threading enabled +* `-` workflow to edit in and bounce back / reload +* `-` abstract file loading (onshape import, mesh replace, etc) +* `-` tighten export dialogs (reduce size for smaller screens) + +## Mesh:Tool + +* `-` face selection and pref +* `-` prefs like normal length +* `-` svg and image import conversion (share code with Kiri:Moto)