Skip to content

Commit

Permalink
Merge branch 'main' into MattFerraro-patch-2
Browse files Browse the repository at this point in the history
  • Loading branch information
MattFerraro authored May 25, 2024
2 parents a2e6dbe + 40f6af3 commit 6d53fb1
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Beyond that, we'll see!

The boundary representation engine under the hood is [truck](https://github.com/ricosjp/truck), which is written in rust and is not dependent on any legacy b-rep engine.

Leveraging truck, we wrote a small rust library called [cadmium](https://github.com/CADmium-Co/CADmium/tree/main/src/rust/cadmium) which provides structs for projects, workspaces, sketches, extrusions, and constraints. Our goal is that this rust library provides all the same functionality as the UI for anyone who prefers code-first CAD. This library is able to save and load projects to disk as json. We have also built a set of javascript bindings so that the whole thing can be compiled to wasm and run in a browser.
Leveraging truck, we wrote a small rust library called [cadmium](https://github.com/CADmium-Co/CADmium/tree/main/packages/cadmium) which provides structs for projects, workspaces, sketches, extrusions, and constraints. My goal is that this rust library provides all the same functionality as the UI for anyone who prefers code-first CAD. This library is able to save and load projects to disk as json. I have also built a set of javascript bindings so that the whole thing can be compiled to wasm and run in a browser.

The UI is built with [SvelteKit](https://kit.svelte.dev/) and [Tailwind](https://tailwindcss.com/). It is hosted with Github Pages. We use [three.js](https://threejs.org/) for rendering, which in this case uses WebGL under the hood. We use [Threlte](https://github.com/threlte/threlte) to manage the scene graph decaratively.
The UI is built with [SvelteKit](https://kit.svelte.dev/) and [Tailwind](https://tailwindcss.com/). It is [hosted here](https://cadmium-co.github.io/CADmium/) on github pages. I use [three.js](https://threejs.org/) for rendering, which in this case uses WebGL under the hood. I use [Threlte](https://github.com/threlte/threlte) to manage the scene graph declaratively.

## License

Expand Down Expand Up @@ -95,6 +95,15 @@ cd applications/web
pnpm test:unit -w
```

### rust

Change the working directory to packages/cadmium and to run rust tests:

```shell
cd packages/cadmium
cargo test
```

## Contributing

We are actively seeking contributors! Please join the [Discord](https://discord.gg/qJCsKJeyZv) and come help out!
Expand Down

0 comments on commit 6d53fb1

Please sign in to comment.