From ef02c6ad5c21d5a64da815cdbf8b15b6796de99a Mon Sep 17 00:00:00 2001 From: Wakeful-Cloud Date: Fri, 2 Jul 2021 16:03:57 -0600 Subject: [PATCH] Updated workflows --- .github/workflows/build.yml | 2 +- .github/workflows/publish.yml | 4 +- README.md | 167 ++++++++++++++++++---------------- wapm.toml | 2 +- 4 files changed, 92 insertions(+), 83 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1f9cb99b9a..baa7bc12ad 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -24,7 +24,7 @@ jobs: # Setup Wasmer - name: Setup Wasmer - uses: cloud-cnc/setup-wasmer@v1 + uses: wasmerio/setup-wasmer@v1 # Checkout 3D printer definitions - name: Checkout 3D printer definitions diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index e9aa110424..7d18004aad 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -20,7 +20,7 @@ jobs: # Setup Wasmer - name: Setup Wasmer - uses: cloud-cnc/setup-wasmer@v1 + uses: wasmerio/setup-wasmer@v1 # Build the Docker image - name: Build the Docker image @@ -49,7 +49,7 @@ jobs: # Publish to WAPM - name: Publish to WAPM - uses: cloud-cnc/wapm-publish@v1 + uses: wasmerio/wapm-publish@v1 with: username: ${{ secrets.WAPM_USERNAME }} password: ${{ secrets.WAPM_PASSWORD }} diff --git a/README.md b/README.md index 7e1ab252e6..1612cec1a1 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,88 @@ -# Cura Engine -[![WAPM](https://wapm.io/package/cloud-cnc-bot/cura-engine/badge.svg)](https://wapm.io/package/cloud-cnc-bot/cura-engine) -[![Build](https://img.shields.io/github/workflow/status/Cloud-CNC/cura-engine/Build?label=Build&style=flat-square)](https://github.com/Cloud-CNC/cura-engine/actions/workflows/build.yml) -[![Publish](https://img.shields.io/github/workflow/status/Cloud-CNC/cura-engine/Publish?label=Publish&style=flat-square)](https://github.com/Cloud-CNC/cura-engine/actions/workflows/publish.yml) - -[Cura Engine](https://github.com/ultimaker/curaengine) for [Web Assembly (WASM)](https://webassembly.org). - -If you're trying to embed Cura Engine into your web application, check out [Cura WASM](https://github.com/cloud-cnc/cura-wasm) instead (Which uses this package under the hood). - -## Installation -```bash -wapm install cloud-cnc-bot/cura-engine -``` -*Note: you'll need to install [WAPM](https://wapm.io) first.* - -## Usage -```bash -# Print help message -wapm run cura-engine -- help - -# Slice Benchy for an Ultimaker 2 -git clone https://github.com/ultimaker/cura.git - -wget https://github.com/CreativeTools/3DBenchy/raw/master/Single-part/3DBenchy.stl -O benchy.stl - -wapm run cura-engine --dir=./cura/resources/definitions --dir=. -- slice -j ./cura/resources/definitions/ultimaker2.def.json -o ./benchy.gcode -l ./data/benchy.stl -``` - -## Development - -### Building -1. Check out the code -2. Build the Docker container: -```bash -docker build . -f docker/build.dockerfile -t cloud-cnc/cura-engine -``` -3. Run the Docker container: -```bash -docker run -it --name cura-engine cloud-cnc/cura-engine -``` -4. Build Cura Engine: -```bash -# This should be run within the container -./build.sh -``` - -## FAQ - -### What is this fork for? -This fork contains a version of Cura Engine compatible with and optimized for WASM. - -### How close is this fork supposed to remain to the source? -Fairly close to reduce the amount of time it takes to support new versions of Cura Engine. - -### Can I contribute? -Yes, absolutely. If you're looking for something specific to help with, performance improvements are always welcome. - -### How does this fork work? -Every Saturday at `00:00 UTC`, [sync.yml](.github/workflows/sync.yml) will create a pull request to synchronize this fork with it's [upstream source](https://github.com/ultimaker/curaengine) and attempt to automatically merge it. On each push, [build.yml](.github/workflows/build.yml) will build and test this fork. When a new release is created, [publish.yml](.github/workflows/publish.yml) will publish it to [WAPM](https://wapm.io). - -## License Obligations - -### Downstream Modifications -You can view downstream modifications by running: -```bash -# Add the upstream repository -git remote add upstream https://github.com/ultimaker/curaengine.git - -# Pull commits from upstream -git pull upstream master - -# Show the differences between the upstream and downstream -git diff upstream/master..origin/main -``` - -### Source -The source of this fork is [github.com/ultimaker/curaengine](https://github.com/ultimaker/curaengine). - -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FCloud-CNC%2Fcura-engine.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FCloud-CNC%2Fcura-engine?ref=badge_large) \ No newline at end of file +# Cura Engine +[![WAPM](https://wapm.io/package/cloud-cnc-bot/cura-engine/badge.svg)](https://wapm.io/package/cloud-cnc-bot/cura-engine) +[![Build](https://img.shields.io/github/workflow/status/Cloud-CNC/cura-engine/Build?label=Build&style=flat-square)](https://github.com/Cloud-CNC/cura-engine/actions/workflows/build.yml) +[![Publish](https://img.shields.io/github/workflow/status/Cloud-CNC/cura-engine/Publish?label=Publish&style=flat-square)](https://github.com/Cloud-CNC/cura-engine/actions/workflows/publish.yml) + +[Cura Engine](https://github.com/ultimaker/curaengine) for [Web Assembly (WASM)](https://webassembly.org). + +If you're trying to embed Cura Engine into your web application, check out [Cura WASM](https://github.com/cloud-cnc/cura-wasm) instead (Which uses this package under the hood). + +## Installation + +```bash +wapm install cloud-cnc-bot/cura-engine +``` + +*Note: you'll need to install [WAPM](https://wapm.io) first.* + +## Usage + +```bash +# Print help message +wapm run cura-engine -- help + +# Slice Benchy for an Ultimaker 2 +git clone https://github.com/ultimaker/cura.git + +wget https://github.com/CreativeTools/3DBenchy/raw/master/Single-part/3DBenchy.stl -O benchy.stl + +wapm run cura-engine --dir=./cura/resources/definitions --dir=. -- slice -j ./cura/resources/definitions/ultimaker2.def.json -o ./benchy.gcode -l ./data/benchy.stl +``` + +## Development + +### Building +1. Check out the code +2. Build the Docker container: + +```bash +docker build . -f docker/build.dockerfile -t cloud-cnc/cura-engine +``` + +3. Run the Docker container: + +```bash +docker run -it --name cura-engine cloud-cnc/cura-engine +``` + +4. Build Cura Engine: + +```bash +# This should be run within the container +./build.sh +``` + +## FAQ + +### What is this fork for? +This fork contains a version of Cura Engine compatible with and optimized for WASM. + +### How close is this fork supposed to remain to the source? +Fairly close to reduce the amount of time it takes to support new versions of Cura Engine. + +### Can I contribute? +Yes, absolutely. If you're looking for something specific to help with, performance improvements are always welcome. + +### How does this fork work? +Every Saturday at `00:00 UTC`, [sync.yml](.github/workflows/sync.yml) will create a pull request to synchronize this fork with it's [upstream source](https://github.com/ultimaker/curaengine) and attempt to automatically merge it. On each push, [build.yml](.github/workflows/build.yml) will build and test this fork. When a new release is created, [publish.yml](.github/workflows/publish.yml) will publish it to [WAPM](https://wapm.io). + +## License Obligations + +### Downstream Modifications +You can view downstream modifications by running: + +```bash +# Add the upstream repository +git remote add upstream https://github.com/ultimaker/curaengine.git + +# Pull commits from upstream +git pull upstream master + +# Show the differences between the upstream and downstream +git diff upstream/master..origin/main +``` + +### Source +The source of this fork is [github.com/ultimaker/curaengine](https://github.com/ultimaker/curaengine). + +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FCloud-CNC%2Fcura-engine.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FCloud-CNC%2Fcura-engine?ref=badge_large) diff --git a/wapm.toml b/wapm.toml index f0e5205dbb..96f164c821 100644 --- a/wapm.toml +++ b/wapm.toml @@ -1,6 +1,6 @@ [package] name = "cloud-cnc-bot/cura-engine" -version = "0.0.1-alpha.1" +version = "0.0.1-alpha.2" description = "Ultimaker Cura Engine for Web Assembly" license = "AGPL-3.0-only" readme = "README.md"